hwpfile.cxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
#include <memory>
#include "precompile.h"
 
#include <algorithm>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <errno.h>
 
#include <o3tl/safeint.hxx>
 
#include "hwplib.h"
#include "hwpfile.h"
#include "hiodev.h"
#include "hfont.h"
#include "hstyle.h"
#include "hbox.h"
#include "hpara.h"
#include "htags.h"
#include "hcode.h"
#include "hstream.hxx"
 
 
HWPFile *HWPFile::cur_doc = nullptr;
static int ccount = 0;
static int pcount = 0;
static int datecodecount = 0;
 
HWPFile::HWPFile()
    : version(HWP_V30)
    , compressed(false)
    , encrypted(false)
    , linenumber(0)
    , info_block_len(0)
    , error_code(HWP_NoError)
    , readdepth(0)
    , m_nCurrentPage(1)
    , m_nMaxSettedPage(0)
    , currenthyper(0)
{
    SetCurrentDoc(this);
}
 
HWPFile::~HWPFile()
{
    oledata.reset();
    hiodev.reset();
}
 
int HWPFile::ReadHwpFile(std::unique_ptr<HStream> stream)
{
    if (Open(std::move(stream)) != HWP_NoError)
        return State();
    InfoRead();
    FontRead();
    StyleRead();
    AddColumnInfo();
    ParaListRead();
    TagsRead();
 
    return State();
}
 
int detect_hwp_version(const char *str)
{
    if (memcmp(V20SIGNATURE, str, HWPIDLen) == 0)
        return HWP_V20;
    else if (memcmp(V21SIGNATURE, str, HWPIDLen) == 0)
        return HWP_V21;
    else if (memcmp(V30SIGNATURE, str, HWPIDLen) == 0)
        return HWP_V30;
    return 0;
}
 
// HIODev wrapper
 
int HWPFile::Open(std::unique_ptr<HStream> stream)
{
    std::unique_ptr<HStreamIODev> hstreamio(new HStreamIODev(std::move(stream)));
 
    if (!hstreamio->open())
    {
        return SetState(HWP_EMPTY_FILE);
    }
 
    SetIODevice(std::move(hstreamio));
 
    char idstr[HWPIDLen];
 
    if (ReadBlock(idstr, HWPIDLen) < HWPIDLen)
        return SetState(HWP_UNSUPPORTED_VERSION);
    version = detect_hwp_version(idstr);
    if (HWP_V30 != version)
        return SetState(HWP_UNSUPPORTED_VERSION);
    return HWP_NoError;
}
 
int HWPFile::SetState(int errcode)
{
    error_code = errcode;
    return error_code;
}
 
bool HWPFile::Read1b(unsigned char &out)
{
    return hiodev && hiodev->read1b(out);
}
 
bool HWPFile::Read1b(char &out)
{
    unsigned char tmp8;
    if (!hiodev || !hiodev->read1b(tmp8))
        return false;
    out = tmp8;
    return true;
}
 
bool HWPFile::Read2b(unsigned short &out)
{
    return hiodev && hiodev->read2b(out);
}
 
bool HWPFile::Read2b(char16_t &out)
{
    unsigned short n;
    auto const ok = Read2b(n);
    if (ok) {
        out = n;
    }
    return ok;
}
 
bool HWPFile::Read4b(unsigned int &out)
{
    return hiodev && hiodev->read4b(out);
}
 
bool HWPFile::Read4b(int &out)
{
    unsigned int tmp32;
    if (!Read4b(tmp32))
        return false;
    out = tmp32;
    return true;
}
 
size_t HWPFile::Read2b(void *ptr, size_t nmemb)
{
    return hiodev ? hiodev->read2b(ptr, nmemb) : 0;
}
 
size_t HWPFile::ReadBlock(void *ptr, size_t size)
{
    return hiodev ? hiodev->readBlock(ptr, size) : 0;
}
 
size_t HWPFile::SkipBlock(size_t size)
{
    return hiodev ? hiodev->skipBlock(size) : 0;
}
 
void HWPFile::SetCompressed(bool flag)
{
    if (hiodev)
        hiodev->setCompressed(flag);
}
 
 
std::unique_ptr<HIODev> HWPFile::SetIODevice(std::unique_ptr<HIODev> new_hiodev)
{
    std::swap(hiodev, new_hiodev);
    return new_hiodev;
}
 
 
// end of HIODev wrapper
 
void HWPFile::InfoRead()
{
    _hwpInfo.Read(*this);
}
 
 
void HWPFile::FontRead()
{
    _hwpFont.Read(*this);
}
 
 
void HWPFile::StyleRead()
{
    _hwpStyle.Read(*this);
}
 
 
void HWPFile::ParaListRead()
{
    ReadParaList(plist);
}
 
void HWPFile::ReadParaList(std::vector < HWPPara* > &aplist)
{
    std::unique_ptr<HWPPara> spNode( new HWPPara );
    unsigned char tmp_etcflag;
    unsigned char prev_etcflag = 0;
    while (spNode->Read(*this, 0))
    {
        if( !(spNode->etcflag & 0x04) ){
            tmp_etcflag = spNode->etcflag;
            spNode->etcflag = prev_etcflag;
            prev_etcflag = tmp_etcflag;
        }
        if (spNode->nch && spNode->reuse_shape)
        {
            if (!aplist.empty()){
                 spNode->pshape = aplist.back()->pshape;
            }
            else{
                 spNode->nch = 0;
                 spNode->reuse_shape = 0;
            }
        }
        spNode->pshape->pagebreak = spNode->etcflag;
        if (spNode->nch)
            AddParaShape(spNode->pshape);
 
        if (!aplist.empty())
            aplist.back()->SetNext(spNode.get());
        aplist.push_back(spNode.release());
        spNode.reset( new HWPPara );
    }
    move_to_failed(std::move(spNode));
}
 
void HWPFile::ReadParaList(std::vector< std::unique_ptr<HWPPara> > &aplist, unsigned char flag)
{
    std::unique_ptr<HWPPara> spNode( new HWPPara );
    unsigned char tmp_etcflag;
    unsigned char prev_etcflag = 0;
    while (spNode->Read(*this, flag))
    {
        if( !(spNode->etcflag & 0x04) ){
          tmp_etcflag = spNode->etcflag;
          spNode->etcflag = prev_etcflag;
          prev_etcflag = tmp_etcflag;
        }
        if (spNode->nch && spNode->reuse_shape)
        {
            if (!aplist.empty()){
                spNode->pshape = aplist.back()->pshape;
            }
            else{
                spNode->nch = 0;
                spNode->reuse_shape = 0;
            }
        }
        spNode->pshape->pagebreak = spNode->etcflag;
        if (spNode->nch)
            AddParaShape(spNode->pshape);
 
        if (!aplist.empty())
            aplist.back()->SetNext(spNode.get());
        aplist.push_back(std::move(spNode));
        spNode.reset( new HWPPara );
    }
    move_to_failed(std::move(spNode));
}
 
void HWPFile::move_to_failed(std::unique_ptr<HWPPara> xPara)
{
    pfailedlist.push_back(std::move(xPara));
}
 
void HWPFile::TagsRead()
{
    while (true)
    {
        uint tag;
        if (!Read4b(tag))
            return;
        int size;
        if (!Read4b(size))
            return;
        if (size <= 0 && tag > 0){
            continue;
        }
 
        if (tag == FILETAG_END_OF_COMPRESSED ||
            tag == FILETAG_END_OF_UNCOMPRESSED)
            return;
        switch (tag)
        {
            case FILETAG_EMBEDDED_PICTURE:
            {
                std::unique_ptr<EmPicture> emb(new EmPicture(size));
 
                if (emb->Read(*this))
                    emblist.push_back(std::move(emb));
            }
            break;
            case FILETAG_OLE_OBJECT:
                oledata.reset( new OlePicture(size) );
                oledata->Read(*this);
                break;
            case FILETAG_HYPERTEXT:
            {
                const int nRecordLen = 617;
                if( (size % nRecordLen) != 0 )
                    SkipBlock( size );
                else
                {
                    const int nRecords = size / nRecordLen;
                    for (int i = 0 ; i < nRecords; ++i)
                    {
                        std::unique_ptr<HyperText> hypert(new HyperText);
                        if (hypert->Read(*this))
                            hyperlist.push_back(std::move(hypert));
                        else
                            break;
                    }
                }
                break;
            }
                case 6:
                {
                     ReadBlock(_hwpInfo.back_info.reserved1, 8);
                     if (!Read4b(_hwpInfo.back_info.luminance))
                        return;
                     if (!Read4b(_hwpInfo.back_info.contrast))
                        return;
                     if (!Read1b(_hwpInfo.back_info.effect))
                        return;
                     ReadBlock(_hwpInfo.back_info.reserved2, 7);
                     ReadBlock(_hwpInfo.back_info.filename, 260);
                     ReadBlock(_hwpInfo.back_info.color, 3);
                     unsigned short nFlag;
                     if (!Read2b(nFlag))
                        return;
                     _hwpInfo.back_info.flag = nFlag >> 8 ;
                     int nRange;
                     if (!Read4b(nRange))
                        return;
                     _hwpInfo.back_info.range = nRange >> 24;
                     ReadBlock(_hwpInfo.back_info.reserved3, 27);
                     if (!Read4b(_hwpInfo.back_info.size))
                        return;
 
                     if (_hwpInfo.back_info.size < 0)
                     {
                        _hwpInfo.back_info.size = 0;
                        return;
                     }
 
                     _hwpInfo.back_info.data.clear();
 
                     //read potentially compressed data in blocks as it's more
                     //likely large values are simply broken and we'll run out
                     //of data before we need to realloc
                     for (int i = 0; i < _hwpInfo.back_info.size; i+= SAL_MAX_UINT16)
                     {
                        int nOldSize = _hwpInfo.back_info.data.size();
                        size_t nBlock = std::min<int>(SAL_MAX_UINT16, _hwpInfo.back_info.size - nOldSize);
                        _hwpInfo.back_info.data.resize(nOldSize + nBlock);
                        size_t nReadBlock = ReadBlock(_hwpInfo.back_info.data.data() + nOldSize, nBlock);
                        if (nBlock != nReadBlock)
                        {
                            _hwpInfo.back_info.data.resize(nOldSize + nReadBlock);
                            break;
                        }
                     }
                     _hwpInfo.back_info.size = _hwpInfo.back_info.data.size();
 
                     if( _hwpInfo.back_info.size > 0 )
                          _hwpInfo.back_info.type = 2;
                     else if( _hwpInfo.back_info.filename[0] )
                          _hwpInfo.back_info.type = 1;
                     else
                          _hwpInfo.back_info.type = 0;
 
 
                     _hwpInfo.back_info.isset = true;
 
                     break;
                }
            case FILETAG_PRESENTATION:
            case FILETAG_PREVIEW_IMAGE:
            case FILETAG_PREVIEW_TEXT:
            default:
                SkipBlock(size);
        }
    }
}
 
 
ColumnDef *HWPFile::GetColumnDef(int num)
{
    if (o3tl::make_unsigned(num) < columnlist.size())
        return columnlist[num]->xColdef.get();
    else
        return nullptr;
}
 
/* Index of @return starts from 1 */
int HWPFile::GetPageMasterNum(int page)
{
    int i = 0;
    for (auto const& column : columnlist)
    {
        if( page < column->start_page )
            return i;
        ++i;
    }
    return i;
}
 
HyperText *HWPFile::GetHyperText()
{
    ++currenthyper;
    if (o3tl::make_unsigned(currenthyper) <= hyperlist.size())
        return hyperlist[currenthyper-1].get();
    else
        return nullptr;
}
 
EmPicture *HWPFile::GetEmPicture(Picture * pic)
{
    char *name = pic->picinfo.picembed.embname;
 
    name[0] = 'H';
    name[1] = 'W';
    name[2] = 'P';
 
    for (auto const& emb : emblist)
        if (strcmp(name, emb->name) == 0)
            return emb.get();
    return nullptr;
}
 
EmPicture *HWPFile::GetEmPictureByName(char * name)
{
    name[0] = 'H';
    name[1] = 'W';
    name[2] = 'P';
 
    for (auto const& emb : emblist)
        if (strcmp(name, emb->name) == 0)
            return emb.get();
    return nullptr;
}
 
ParaShape *HWPFile::getParaShape(int index)
{
    if (index < 0 || o3tl::make_unsigned(index) >= pslist.size())
        return nullptr;
    return pslist[index].get();
}
 
CharShape *HWPFile::getCharShape(int index)
{
    if (index < 0 || o3tl::make_unsigned(index) >= cslist.size())
        return nullptr;
    return cslist[index].get();
}
 
FBoxStyle *HWPFile::getFBoxStyle(int index)
{
    if (index < 0 || o3tl::make_unsigned(index) >= fbslist.size())
        return nullptr;
    return fbslist[index];
}
 
DateCode *HWPFile::getDateCode(int index)
{
    if (index < 0 || o3tl::make_unsigned(index) >= datecodes.size())
        return nullptr;
    return datecodes[index];
}
 
HeaderFooter *HWPFile::getHeaderFooter(int index)
{
    if (index < 0 || o3tl::make_unsigned(index) >= headerfooters.size())
        return nullptr;
    return headerfooters[index];
}
 
ShowPageNum *HWPFile::getPageNumber(int index)
{
    if (index < 0 || o3tl::make_unsigned(index) >= pagenumbers.size())
        return nullptr;
    return pagenumbers[index];
}
 
Table *HWPFile::getTable(int index)
{
    if (index < 0 || o3tl::make_unsigned(index) >= tables.size())
        return nullptr;
    return tables[index].get();
}
 
void HWPFile::AddParaShape(std::shared_ptr<ParaShape> const & pshape)
{
    int nscount = 0;
    for(int j = 0 ; j < MAXTABS-1 ; j++)
    {
        if( j > 0 && pshape->tabs[j].position == 0 )
          break;
        if( pshape->tabs[0].position == 0 ){
            if( pshape->tabs[j].type || pshape->tabs[j].dot_continue ||
                 (pshape->tabs[j].position != 1000 *j) )
                      nscount = j;
        }
        else {
            if( pshape->tabs[j].type || pshape->tabs[j].dot_continue ||
                (pshape->tabs[j].position != 1000 * (j + 1)) )
                    nscount = j;
          }
    }
    if( nscount )
    {
        pshape->tabs[MAXTABS-1].type = sal::static_int_cast<char>(nscount);
        pshape->index = ++pcount;
        pslist.push_back(pshape);
        return;
    }
 
    int value = compareParaShape(pshape.get());
    if (value == 0)
    {
        pshape->index = ++pcount;
        pslist.push_back(pshape);
        return;
    }
    pshape->index = value;
}
 
void HWPFile::AddCharShape(std::shared_ptr<CharShape> const & cshape)
{
    int value = compareCharShape(cshape.get());
    if (value == 0)
    {
        cshape->index = ++ccount;
        cslist.push_back(cshape);
    }
    else
        cshape->index = value;
}
 
void HWPFile::AddColumnInfo()
{
    columnlist.emplace_back(new ColumnInfo(m_nCurrentPage));
    setMaxSettedPage();
}
 
void HWPFile::SetColumnDef(const std::shared_ptr<ColumnDef>& rColdef)
{
    ColumnInfo *cinfo = columnlist.back().get();
    if( cinfo->bIsSet )
        return;
    cinfo->xColdef = rColdef;
    cinfo->bIsSet = true;
}
 
void HWPFile::AddDateFormat(DateCode * hbox)
{
    hbox->key = sal::static_int_cast<char>(++datecodecount);
    datecodes.push_back(hbox);
}
 
void HWPFile::AddPageNumber(ShowPageNum * hbox)
{
    pagenumbers.push_back(hbox);
}
 
void HWPFile::AddHeaderFooter(HeaderFooter * hbox)
{
    headerfooters.push_back(hbox);
}
 
void HWPFile::AddTable(std::unique_ptr<Table> hbox)
{
    tables.push_back(std::move(hbox));
}
 
void HWPFile::AddFBoxStyle(FBoxStyle * fbstyle)
{
    fbslist.push_back(fbstyle);
}
 
int HWPFile::compareCharShape(CharShape const *shape)
{
    int count = cslist.size();
    for(int i = 0; i< count; i++)
    {
        CharShape *cshape = getCharShape(i);
 
        if( shape->size == cshape->size &&
            shape->font == cshape->font &&
            shape->ratio == cshape->ratio &&
            shape->space == cshape->space &&
            shape->color[1] == cshape->color[1] &&
            shape->color[0] == cshape->color[0] &&
            shape->shade == cshape->shade &&
            shape->attr == cshape->attr )
        {
            return cshape->index;
        }
    }
    return 0;
}
 
int HWPFile::compareParaShape(const ParaShape* shape)
{
    if (!shape->cshape)
        return 0;
 
    int count = pslist.size();
    for (int i = 0; i < count; ++i)
    {
        ParaShape *pshape = pslist[i].get();
        if (!pshape->cshape)
            continue;
        if (shape->left_margin == pshape->left_margin &&
            shape->right_margin == pshape->right_margin &&
            shape->pspacing_prev == pshape->pspacing_prev &&
            shape->pspacing_next == pshape->pspacing_next &&
            shape->indent == pshape->indent &&
            shape->lspacing == pshape->lspacing &&
            shape->arrange_type == pshape->arrange_type &&
            shape->outline == pshape->outline &&
            shape->pagebreak == pshape->pagebreak)
        {
            if (shape->cshape->size == pshape->cshape->size &&
                shape->cshape->font == pshape->cshape->font &&
                shape->cshape->ratio == pshape->cshape->ratio &&
                shape->cshape->space == pshape->cshape->space &&
                shape->cshape->color[1] == pshape->cshape->color[1] &&
                shape->cshape->color[0] == pshape->cshape->color[0] &&
                shape->cshape->shade == pshape->cshape->shade &&
                shape->cshape->attr == pshape->cshape->attr)
            {
                return pshape->index;
            }
        }
    }
    return 0;
}
 
HWPFile *GetCurrentDoc()
{
    return HWPFile::cur_doc;
}
 
 
HWPFile *SetCurrentDoc(HWPFile * hwpfp)
{
    HWPFile *org = HWPFile::cur_doc;
 
    HWPFile::cur_doc = hwpfp;
    return org;
}
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */