source: trunk/libdjvu/DjVuDocument.cpp @ 269

Last change on this file since 269 was 206, checked in by Eugene Romanenko, 14 years ago

DJVU plugin: djvulibre updated to version 3.5.19

File size: 53.3 KB
Line 
1//C-  -*- C++ -*-
2//C- -------------------------------------------------------------------
3//C- DjVuLibre-3.5
4//C- Copyright (c) 2002  Leon Bottou and Yann Le Cun.
5//C- Copyright (c) 2001  AT&T
6//C-
7//C- This software is subject to, and may be distributed under, the
8//C- GNU General Public License, either Version 2 of the license,
9//C- or (at your option) any later version. The license should have
10//C- accompanied the software or you may obtain a copy of the license
11//C- from the Free Software Foundation at http://www.fsf.org .
12//C-
13//C- This program is distributed in the hope that it will be useful,
14//C- but WITHOUT ANY WARRANTY; without even the implied warranty of
15//C- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16//C- GNU General Public License for more details.
17//C-
18//C- DjVuLibre-3.5 is derived from the DjVu(r) Reference Library from
19//C- Lizardtech Software.  Lizardtech Software has authorized us to
20//C- replace the original DjVu(r) Reference Library notice by the following
21//C- text (see doc/lizard2002.djvu and doc/lizardtech2007.djvu):
22//C-
23//C-  ------------------------------------------------------------------
24//C- | DjVu (r) Reference Library (v. 3.5)
25//C- | Copyright (c) 1999-2001 LizardTech, Inc. All Rights Reserved.
26//C- | The DjVu Reference Library is protected by U.S. Pat. No.
27//C- | 6,058,214 and patents pending.
28//C- |
29//C- | This software is subject to, and may be distributed under, the
30//C- | GNU General Public License, either Version 2 of the license,
31//C- | or (at your option) any later version. The license should have
32//C- | accompanied the software or you may obtain a copy of the license
33//C- | from the Free Software Foundation at http://www.fsf.org .
34//C- |
35//C- | The computer code originally released by LizardTech under this
36//C- | license and unmodified by other parties is deemed "the LIZARDTECH
37//C- | ORIGINAL CODE."  Subject to any third party intellectual property
38//C- | claims, LizardTech grants recipient a worldwide, royalty-free,
39//C- | non-exclusive license to make, use, sell, or otherwise dispose of
40//C- | the LIZARDTECH ORIGINAL CODE or of programs derived from the
41//C- | LIZARDTECH ORIGINAL CODE in compliance with the terms of the GNU
42//C- | General Public License.   This grant only confers the right to
43//C- | infringe patent claims underlying the LIZARDTECH ORIGINAL CODE to
44//C- | the extent such infringement is reasonably necessary to enable
45//C- | recipient to make, have made, practice, sell, or otherwise dispose
46//C- | of the LIZARDTECH ORIGINAL CODE (or portions thereof) and not to
47//C- | any greater extent that may be necessary to utilize further
48//C- | modifications or combinations.
49//C- |
50//C- | The LIZARDTECH ORIGINAL CODE is provided "AS IS" WITHOUT WARRANTY
51//C- | OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
52//C- | TO ANY WARRANTY OF NON-INFRINGEMENT, OR ANY IMPLIED WARRANTY OF
53//C- | MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
54//C- +------------------------------------------------------------------
55//
56// $Id: DjVuDocument.cpp,v 1.17 2007/03/25 20:48:30 leonb Exp $
57// $Name: release_3_5_19 $
58
59#ifdef HAVE_CONFIG_H
60# include "config.h"
61#endif
62#if NEED_GNUG_PRAGMAS
63# pragma implementation
64#endif
65
66#include "DjVuDocument.h"
67#include "DjVmDoc.h"
68#include "DjVmDir0.h"
69#include "DjVmNav.h"
70#include "DjVuNavDir.h"
71#include "DjVuImage.h"
72#include "DjVuFileCache.h"
73#include "IFFByteStream.h"
74#include "GOS.h"
75#include "DataPool.h"
76#include "IW44Image.h"
77#include "GRect.h"
78
79#include "debug.h"
80
81
82#ifdef HAVE_NAMESPACES
83namespace DJVU {
84# ifdef NOT_DEFINED // Just to fool emacs c++ mode
85}
86#endif
87#endif
88
89
90static const char octets[4]={0x41,0x54,0x26,0x54};
91const float     DjVuDocument::thumb_gamma=(float)2.20;
92
93void (* DjVuDocument::djvu_import_codec)(
94  GP<DataPool> &pool, const GURL &url, bool &needs_compression,
95  bool &needs_rename )=0;
96
97void (* DjVuDocument::djvu_compress_codec)(
98  GP<ByteStream> &doc,const GURL &where,bool bundled)=0;
99
100void
101DjVuDocument::set_import_codec(
102  void (*codec)(
103    GP<DataPool> &pool, const GURL &url, bool &needs_compression, bool &needs_rename ))
104{
105  djvu_import_codec=codec;
106}
107
108void
109DjVuDocument::set_compress_codec(
110  void (* codec)(
111    GP<ByteStream> &doc,const GURL &where,bool bundled))
112{
113  djvu_compress_codec=codec;
114}
115
116DjVuDocument::DjVuDocument(void)
117  : doc_type(UNKNOWN_TYPE),
118    needs_compression_flag(false),
119    can_compress_flag(false),
120    needs_rename_flag(false),
121    has_url_names(false),
122    recover_errors(ABORT),
123    verbose_eof(false),
124    init_started(false),
125    cache(0) 
126{
127}
128
129GP<DjVuDocument>
130DjVuDocument::create(
131  GP<DataPool> pool, GP<DjVuPort> xport, DjVuFileCache * const xcache)
132{
133  DjVuDocument *doc=new DjVuDocument;
134  GP<DjVuDocument> retval=doc;
135  doc->init_data_pool=pool;
136  doc->start_init(GURL(),xport,xcache);
137  return retval;
138}
139
140GP<DjVuDocument>
141DjVuDocument::create(
142  const GP<ByteStream> &bs, GP<DjVuPort> xport, DjVuFileCache * const xcache)
143{
144  return create(DataPool::create(bs),xport,xcache);
145}
146
147GP<DjVuDocument>
148DjVuDocument::create_wait(
149  const GURL &url, GP<DjVuPort> xport, DjVuFileCache * const xcache)
150{
151  GP<DjVuDocument> retval=create(url,xport,xcache);
152  retval->wait_for_complete_init();
153  return retval;
154}
155
156void
157DjVuDocument::start_init(
158  const GURL & url, GP<DjVuPort> xport, DjVuFileCache * xcache)
159{
160   DEBUG_MSG("DjVuDocument::start_init(): initializing class...\n");
161   DEBUG_MAKE_INDENT(3);
162   if (init_started)
163      G_THROW( ERR_MSG("DjVuDocument.2nd_init") );
164   if (!get_count())
165      G_THROW( ERR_MSG("DjVuDocument.not_secure") );
166   if(url.is_empty())
167   {
168     if (!init_data_pool)
169       G_THROW( ERR_MSG("DjVuDocument.empty_url") );
170     if(init_url.is_empty())
171     {
172       init_url=invent_url("document.djvu");
173     }
174   }else
175   {
176     init_url=url;
177   }
178   
179      // Initialize
180   cache=xcache;
181   doc_type=UNKNOWN_TYPE;
182   DjVuPortcaster * pcaster=get_portcaster();
183   if (!xport)
184     xport=simple_port=new DjVuSimplePort();
185   pcaster->add_route(this, xport);
186   pcaster->add_route(this, this);
187
188   if(!url.is_empty())
189   {
190     init_data_pool=pcaster->request_data(this, init_url);
191     if(init_data_pool)
192     {
193       if(!init_url.is_empty() && init_url.is_local_file_url() && djvu_import_codec)
194       {
195         djvu_import_codec(init_data_pool,init_url,needs_compression_flag,needs_rename_flag);
196       }
197       if(needs_rename_flag)
198         can_compress_flag=true;
199     }
200     if (!init_data_pool) 
201     {
202       G_THROW( ERR_MSG("DjVuDocument.fail_URL") "\t"+init_url.get_string());
203     }
204   }
205      // Now we say it is ready
206   init_started=true;
207
208   init_thread_flags=STARTED;
209   init_life_saver=this;
210   init_thr.create(static_init_thread, this);
211}
212
213DjVuDocument::~DjVuDocument(void)
214{
215      // No more messages, please. We're being destroyed.
216   get_portcaster()->del_port(this);
217
218      // We want to stop any DjVuFile which has been created by us
219      // and is still being decoded. We have to stop them manually because
220      // they keep the "life saver" in the decoding thread and won't stop
221      // when we clear the last reference to them
222   {
223      GCriticalSectionLock lock(&ufiles_lock);
224      for(GPosition pos=ufiles_list;pos;++pos)
225      {
226          GP<DjVuFile> file=ufiles_list[pos]->file;
227          file->stop_decode(false);
228          file->stop(false);    // Disable any access to data
229      }
230      ufiles_list.empty();
231   }
232
233   GPList<DjVuPort> ports=get_portcaster()->prefix_to_ports(get_int_prefix());
234   for(GPosition pos=ports;pos;++pos)
235   {
236     GP<DjVuPort> port=ports[pos];
237     if (port->inherits("DjVuFile"))
238     {
239       DjVuFile * file=(DjVuFile *) (DjVuPort *) port;
240       file->stop_decode(false);
241       file->stop(false);       // Disable any access to data
242     }
243   }
244   DataPool::close_all();
245}
246
247void
248DjVuDocument::stop_init(void)
249{
250   DEBUG_MSG("DjVuDocument::stop_init(): making sure that the init thread dies.\n");
251   DEBUG_MAKE_INDENT(3);
252
253   GMonitorLock lock(&init_thread_flags);
254   while((init_thread_flags & STARTED) &&
255         !(init_thread_flags & FINISHED))
256   {
257      if (init_data_pool) init_data_pool->stop(true);   // blocking operation
258
259      if (ndir_file) ndir_file->stop(false);
260
261      {
262         GCriticalSectionLock lock(&ufiles_lock);
263         for(GPosition pos=ufiles_list;pos;++pos)
264            ufiles_list[pos]->file->stop(false);        // Disable any access to data
265         ufiles_list.empty();
266      }
267
268      init_thread_flags.wait(50);
269   }
270}
271
272void
273DjVuDocument::check() const
274{
275  if (!init_started)
276    G_THROW( ERR_MSG("DjVuDocument.not_init") );
277}
278
279void
280DjVuDocument::static_init_thread(void * cl_data)
281{
282  DjVuDocument * th=(DjVuDocument *) cl_data;
283  GP<DjVuDocument> life_saver=th;
284  th->init_life_saver=0;
285  G_TRY {
286    th->init_thread();
287  } G_CATCH(exc) {
288    G_TRY {
289      int changed = DjVuDocument::DOC_INIT_FAILED;
290      th->flags |= changed;
291      get_portcaster()->notify_doc_flags_changed(th, changed, 0);
292    } G_CATCH_ALL {
293    } G_ENDCATCH;
294    G_TRY {
295      th->check_unnamed_files();
296      if (!exc.cmp_cause(ByteStream::EndOfFile) && th->verbose_eof)
297        get_portcaster()->notify_error(th, ERR_MSG("DjVuDocument.init_eof"));
298      else if (!exc.cmp_cause(DataPool::Stop))
299        get_portcaster()->notify_status(th, ERR_MSG("DjVuDocument.stopped"));
300      else
301        get_portcaster()->notify_error(th, exc.get_cause());
302    } G_CATCH_ALL {
303    } G_ENDCATCH;
304    th->init_thread_flags |= FINISHED;
305  } G_ENDCATCH;
306}
307
308void
309DjVuDocument::init_thread(void)
310      // This function is run in a separate thread.
311      // The goal is to detect the document type (BUNDLED, OLD_INDEXED, etc.)
312      // and decode navigation directory.
313{
314   DEBUG_MSG("DjVuDocument::init_thread(): guessing what we're dealing with\n");
315   DEBUG_MAKE_INDENT(3);
316
317   DjVuPortcaster * pcaster=get_portcaster();
318     
319   GP<ByteStream> stream=init_data_pool->get_stream();
320
321   GP<IFFByteStream> giff=IFFByteStream::create(stream);
322   IFFByteStream &iff=*giff;
323   GUTF8String chkid;
324   int size=iff.get_chunk(chkid);
325   if (!size)
326     G_THROW( ByteStream::EndOfFile );
327   if (size < 0)
328     G_THROW( ERR_MSG("DjVuDocument.no_file") );
329   if (size<8)
330     G_THROW( ERR_MSG("DjVuDocument.not_DjVu") );
331   if (chkid=="FORM:DJVM")
332   {
333     DEBUG_MSG("Got DJVM document here\n");
334     DEBUG_MAKE_INDENT(3);
335     
336     size=iff.get_chunk(chkid);
337     if (chkid=="DIRM")
338       {
339         djvm_dir=DjVmDir::create();
340         djvm_dir->decode(iff.get_bytestream());
341         iff.close_chunk();
342         if (djvm_dir->is_bundled())
343           {
344             DEBUG_MSG("Got BUNDLED file.\n");
345             doc_type=BUNDLED;
346           } 
347         else
348           {
349             DEBUG_MSG("Got INDIRECT file.\n");
350             doc_type=INDIRECT;
351           }
352         flags|=DOC_TYPE_KNOWN | DOC_DIR_KNOWN;
353         pcaster->notify_doc_flags_changed(this, 
354                                           DOC_TYPE_KNOWN | DOC_DIR_KNOWN, 0);
355         check_unnamed_files();
356         
357         /* Check for NAVM */
358         size=iff.get_chunk(chkid);
359         if (size && chkid=="NAVM")
360           {
361             djvm_nav=DjVmNav::create();
362             djvm_nav->decode(iff.get_bytestream());
363             iff.close_chunk();
364           }
365       }
366     else if (chkid=="DIR0")
367       {
368         DEBUG_MSG("Got OLD_BUNDLED file.\n");
369         doc_type=OLD_BUNDLED;
370         flags|=DOC_TYPE_KNOWN;
371         pcaster->notify_doc_flags_changed(this, DOC_TYPE_KNOWN, 0);
372         check_unnamed_files();
373       } 
374     else 
375       G_THROW( ERR_MSG("DjVuDocument.bad_format") );
376     
377     if (doc_type==OLD_BUNDLED)
378       {
379         // Read the DjVmDir0 directory. We are unable to tell what
380         // files are pages and what are included at this point.
381         // We only know that the first file with DJVU (BM44 or PM44)
382         // form *is* the first page. The rest will become known
383         // after we decode DjVuNavDir
384         djvm_dir0=DjVmDir0::create();
385         djvm_dir0->decode(*iff.get_bytestream());
386         iff.close_chunk();
387         // Get offset to the first DJVU, PM44 or BM44 chunk
388         int first_page_offset=0;
389         while(!first_page_offset)
390           {
391             int offset;
392             size=iff.get_chunk(chkid, &offset);
393             if (size==0) G_THROW( ERR_MSG("DjVuDocument.no_page") );
394             if (chkid=="FORM:DJVU" || 
395                 chkid=="FORM:PM44" || chkid=="FORM:BM44")
396               {
397                 DEBUG_MSG("Got 1st page offset=" << offset << "\n");
398                 first_page_offset=offset;
399               }
400             iff.close_chunk();
401           }
402         
403         // Now get the name of this file
404         int file_num;
405         for(file_num=0;file_num<djvm_dir0->get_files_num();file_num++)
406           {
407             DjVmDir0::FileRec & file=*djvm_dir0->get_file(file_num);
408             if (file.offset==first_page_offset)
409               {
410                 first_page_name=file.name;
411                 break;
412               }
413           }
414         if (!first_page_name.length())
415           G_THROW( ERR_MSG("DjVuDocument.no_page") );
416         flags|=DOC_DIR_KNOWN;
417         pcaster->notify_doc_flags_changed(this, DOC_DIR_KNOWN, 0);
418         check_unnamed_files();
419       }
420   } 
421   else // chkid!="FORM:DJVM"
422     {
423       // DJVU format
424       DEBUG_MSG("Got DJVU OLD_INDEXED or SINGLE_PAGE document here.\n");
425       doc_type=SINGLE_PAGE;
426       flags |= DOC_TYPE_KNOWN;
427       pcaster->notify_doc_flags_changed(this, DOC_TYPE_KNOWN, 0);
428       check_unnamed_files();
429     }
430   if (doc_type==OLD_BUNDLED || doc_type==SINGLE_PAGE)
431     {
432       DEBUG_MSG("Searching for NDIR chunks...\n");
433       ndir_file=get_djvu_file(-1);
434       if (ndir_file) ndir=ndir_file->decode_ndir();
435       ndir_file=0;     // Otherwise ~DjVuDocument() will stop (=kill) it
436       if (!ndir)
437         {
438           // Seems to be 1-page old-style document. Create dummy NDIR
439           if (doc_type==OLD_BUNDLED)
440             {
441               ndir=DjVuNavDir::create(GURL::UTF8("directory",init_url));
442               ndir->insert_page(-1, first_page_name);
443             } 
444           else
445             {
446               ndir=DjVuNavDir::create(GURL::UTF8("directory",init_url.base()));
447               ndir->insert_page(-1, init_url.fname());
448             }
449         } 
450       else
451         {
452           if (doc_type==SINGLE_PAGE)
453             doc_type=OLD_INDEXED;
454         }
455       flags|=DOC_NDIR_KNOWN;
456       pcaster->notify_doc_flags_changed(this, DOC_NDIR_KNOWN, 0);
457       check_unnamed_files();
458     }
459   
460   flags |= DOC_INIT_OK;
461   pcaster->notify_doc_flags_changed(this, DOC_INIT_OK, 0);
462   check_unnamed_files();
463   init_thread_flags|=FINISHED;
464   DEBUG_MSG("DOCUMENT IS FULLY INITIALIZED now: doc_type='" <<
465             (doc_type==BUNDLED ? "BUNDLED" :
466              doc_type==OLD_BUNDLED ? "OLD_BUNDLED" :
467              doc_type==INDIRECT ? "INDIRECT" :
468              doc_type==OLD_INDEXED ? "OLD_INDEXED" :
469              doc_type==SINGLE_PAGE ? "SINGLE_PAGE" :
470              "UNKNOWN") << "'\n");
471}
472
473bool
474DjVuDocument::wait_for_complete_init(void)
475{
476  flags.enter();
477  while(!(flags & DOC_INIT_FAILED) &&
478        !(flags & DOC_INIT_OK)) flags.wait();
479  flags.leave();
480  init_thread_flags.enter();
481  while (!(init_thread_flags & FINISHED))
482    init_thread_flags.wait();
483  init_thread_flags.leave();
484  return (flags & (DOC_INIT_OK | DOC_INIT_FAILED))!=0;
485}
486
487int
488DjVuDocument::wait_get_pages_num(void) const
489{
490  GSafeFlags &f=const_cast<GSafeFlags &>(flags);
491  f.enter();
492  while(!(f & DOC_TYPE_KNOWN) &&
493        !(f & DOC_INIT_FAILED) &&
494        !(f & DOC_INIT_OK)) f.wait();
495  f.leave();
496  return get_pages_num();
497}
498
499GUTF8String
500DjVuDocument::get_int_prefix(void) const
501{
502      // These NAMEs are used to enable DjVuFile sharing inside the same
503      // DjVuDocument using DjVuPortcaster. Since URLs are unique to the
504      // document, other DjVuDocuments cannot retrieve files until they're
505      // assigned some permanent name. After '?' there should be the real
506      // file's URL. Please note, that output of this function is used only
507      // as name for DjVuPortcaster. Not as a URL.
508   GUTF8String retval;
509   return retval.format("document_%p%d?", this, hash(init_url));
510}
511
512void
513DjVuDocument::set_file_aliases(const DjVuFile * file)
514{
515   DEBUG_MSG("DjVuDocument::set_file_aliases(): setting global aliases for file '"
516             << file->get_url() << "'\n");
517   DEBUG_MAKE_INDENT(3);
518
519   DjVuPortcaster * pcaster=DjVuPort::get_portcaster();
520   
521   GMonitorLock lock(&((DjVuFile *) file)->get_safe_flags());
522   pcaster->clear_aliases(file);
523   if (file->is_decode_ok() && cache)
524   {
525         // If file is successfully decoded and caching is enabled,
526         // assign a global alias to this file, so that any other
527         // DjVuDocument will be able to use it.
528     
529      pcaster->add_alias(file, file->get_url().get_string());
530      if (flags & (DOC_NDIR_KNOWN | DOC_DIR_KNOWN))
531      {
532         int page_num=url_to_page(file->get_url());
533         if (page_num>=0)
534         {
535            if (page_num==0) pcaster->add_alias(file, init_url.get_string()+"#-1");
536            pcaster->add_alias(file, init_url.get_string()+"#"+GUTF8String(page_num));
537         }
538      }
539         // The following line MUST stay here. For OLD_INDEXED documents
540         // a page may finish decoding before DIR or NDIR becomes known
541         // (multithreading, remember), so the code above would not execute
542      pcaster->add_alias(file, file->get_url().get_string()+"#-1");
543   } else pcaster->add_alias(file, get_int_prefix()+file->get_url());
544}
545
546void
547DjVuDocument::check_unnamed_files(void)
548{
549  DEBUG_MSG("DjVuDocument::check_unnamed_files(): Seeing if we can fix some...\n");
550  DEBUG_MAKE_INDENT(3);
551 
552  if (flags & DOC_INIT_FAILED)
553  {
554    // Init failed. All unnamed files should be terminated
555    GCriticalSectionLock lock(&ufiles_lock);
556    for(GPosition pos=ufiles_list;pos;++pos)
557    {
558      GP<DjVuFile> file=ufiles_list[pos]->file;
559      file->stop_decode(true);
560      file->stop(false);        // Disable any access to data
561    }
562    ufiles_list.empty();
563    return;
564  }
565 
566  if ((flags & DOC_TYPE_KNOWN)==0)
567    return;
568 
569  // See the list of unnamed files (created when there was insufficient
570  // information about DjVuDocument structure) and try to fix those,
571  // which can be fixed at this time
572  while(true)
573  {
574    DjVuPortcaster * pcaster=get_portcaster();
575   
576    GP<UnnamedFile> ufile;
577    GURL new_url;
578    GPosition pos ;   
579           GCriticalSectionLock lock(&ufiles_lock);
580     for(pos=ufiles_list;pos;)
581     {
582        G_TRY
583        {
584          GP<UnnamedFile> f=ufiles_list[pos];
585          if (f->id_type==UnnamedFile::ID) 
586            new_url=id_to_url(f->id);
587          else 
588            new_url=page_to_url(f->page_num);
589          if (!new_url.is_empty())
590          {
591            ufile=f;
592            // Don't take it off the list. We want to be
593            // able to stop the init from ~DjVuDocument();
594            //
595            // ufiles_list.del(pos);
596            break;
597          } else if (is_init_complete())
598          {
599            // No empty URLs are allowed at this point.
600            // We now know all information about the document
601            // and can determine if a page is inside it or not
602            f->data_pool->set_eof();
603            GUTF8String msg;
604            if (f->id_type==UnnamedFile::ID)
605              msg= ERR_MSG("DjVuDocument.miss_page_name") "\t"+f->id;
606            else 
607              msg= ERR_MSG("DjVuDocument.miss_page_num") "\t"+GUTF8String(f->page_num);
608            G_THROW(msg);
609          }
610          ++pos;
611        }
612        G_CATCH(exc)
613        {
614          pcaster->notify_error(this, exc.get_cause());
615          GP<DataPool> pool=ufiles_list[pos]->data_pool;
616          if (pool)
617            pool->stop();
618          GPosition this_pos=pos;
619          ++pos;
620          ufiles_list.del(this_pos);
621        }
622        G_ENDCATCH;
623     }
624     
625     if (ufile && !new_url.is_empty())
626       {
627         DEBUG_MSG("Fixing file: '" << ufile->url << "'=>'" << new_url << "'\n");
628         // Now, once we know its real URL we can request a real DataPool and
629         // can connect the DataPool owned by DjVuFile to that real one
630         // Note, that now request_data() will not play fool because
631         // we have enough information
632         
633         G_TRY
634           {
635             if (ufile->data_pool)
636               {
637                 GP<DataPool> new_pool=pcaster->request_data(ufile->file, new_url);
638                 if(!new_pool)
639                   G_THROW( ERR_MSG("DjVuDocument.fail_URL") "\t"+new_url.get_string());
640                 ufile->data_pool->connect(new_pool);
641               }
642             ufile->file->set_name(new_url.fname());
643             ufile->file->move(new_url.base());
644             set_file_aliases(ufile->file);
645           }
646         G_CATCH(exc)
647           {
648             pcaster->notify_error(this, exc.get_cause());
649           }   
650         G_ENDCATCH;
651       }
652     else
653       break;
654     
655     // Remove the 'ufile' from the list
656     for(pos=ufiles_list;pos;++pos)
657       if (ufiles_list[pos]==ufile)
658         {
659           ufiles_list.del(pos);
660           break;
661         }
662  } // while(1)
663}
664
665int
666DjVuDocument::get_pages_num(void) const
667{
668   check();
669   if (flags & DOC_TYPE_KNOWN)
670      if (doc_type==BUNDLED || doc_type==INDIRECT)
671         return djvm_dir->get_pages_num();
672      else if (flags & DOC_NDIR_KNOWN)
673         return ndir->get_pages_num();
674   return 1;
675}
676
677GURL
678DjVuDocument::page_to_url(int page_num) const
679{
680   check();
681   DEBUG_MSG("DjVuDocument::page_to_url(): page_num=" << page_num << "\n");
682   DEBUG_MAKE_INDENT(3);
683   
684   GURL url;
685   if (flags & DOC_TYPE_KNOWN)
686      switch(doc_type)
687      {
688         case SINGLE_PAGE:
689         case OLD_INDEXED:
690         {
691            if (page_num<0) url=init_url;
692            else if (flags & DOC_NDIR_KNOWN) url=ndir->page_to_url(page_num);
693            break;
694         }
695         case OLD_BUNDLED:
696         {
697            if (page_num<0) page_num=0;
698            if (page_num==0 && (flags & DOC_DIR_KNOWN))
699               url=GURL::UTF8(first_page_name,init_url);
700            else if (flags & DOC_NDIR_KNOWN)
701               url=ndir->page_to_url(page_num);
702            break;
703         }
704         case BUNDLED:
705         {
706            if (page_num<0)
707              page_num=0;
708            if (flags & DOC_DIR_KNOWN)
709            {
710              GP<DjVmDir::File> file=djvm_dir->page_to_file(page_num);
711              if (!file) G_THROW( ERR_MSG("DjVuDocument.big_num") );
712              url=GURL::UTF8(file->get_load_name(),init_url);
713            }
714            break;
715         }
716         case INDIRECT:
717         {
718            if (page_num<0) page_num=0;
719            if (flags & DOC_DIR_KNOWN)
720            {
721               GP<DjVmDir::File> file=djvm_dir->page_to_file(page_num);
722               if (!file)
723                 G_THROW( ERR_MSG("DjVuDocument.big_num") );
724               url=GURL::UTF8(file->get_load_name(),init_url.base());
725            }
726            break;
727         }
728         default:
729            G_THROW( ERR_MSG("DjVuDocument.unk_type") );
730      }
731   return url;
732}
733
734int
735DjVuDocument::url_to_page(const GURL & url) const
736{
737   check();
738   DEBUG_MSG("DjVuDocument::url_to_page(): url='" << url << "'\n");
739   DEBUG_MAKE_INDENT(3);
740
741   int page_num=-1;
742   if (flags & DOC_TYPE_KNOWN)
743      switch(doc_type)
744      {
745         case SINGLE_PAGE:
746         case OLD_BUNDLED:
747         case OLD_INDEXED:
748         {
749            if (flags & DOC_NDIR_KNOWN) page_num=ndir->url_to_page(url);
750            break;
751         }
752         case BUNDLED:
753         {
754            if (flags & DOC_DIR_KNOWN)
755            {
756               GP<DjVmDir::File> file;
757               if (url.base()==init_url)
758                 file=djvm_dir->id_to_file(url.fname());
759               if (file)
760                 page_num=file->get_page_num();
761            }
762            break;
763         }
764         case INDIRECT:
765         {
766            if (flags & DOC_DIR_KNOWN)
767            {
768               GP<DjVmDir::File> file;
769               if (url.base()==init_url.base())
770                 file=djvm_dir->id_to_file(url.fname());
771               if (file)
772                 page_num=file->get_page_num();
773            }
774            break;
775         }
776         default:
777            G_THROW( ERR_MSG("DjVuDocument.unk_type") );
778      }
779   return page_num;
780}
781
782GURL
783DjVuDocument::id_to_url(const GUTF8String & id) const
784{
785   check();
786   DEBUG_MSG("DjVuDocument::id_to_url(): translating ID='" << id << "' to URL\n");
787   DEBUG_MAKE_INDENT(3);
788
789   if (flags & DOC_TYPE_KNOWN)
790      switch(doc_type)
791      {
792         case BUNDLED:
793            if (flags & DOC_DIR_KNOWN)
794            {
795              GP<DjVmDir::File> file=djvm_dir->id_to_file(id);
796              if (!file)
797              {
798                file=djvm_dir->name_to_file(id);
799                if (!file)
800                  file=djvm_dir->title_to_file(id);
801              }
802              if (file)
803                return GURL::UTF8(file->get_load_name(),init_url);
804            }
805            break;
806         case INDIRECT:
807            if (flags & DOC_DIR_KNOWN)
808            {
809               GP<DjVmDir::File> file=djvm_dir->id_to_file(id);
810               if (!file)
811               {
812                 file=djvm_dir->name_to_file(id);
813                 if (!file)
814                   file=djvm_dir->title_to_file(id);
815               }
816               if (file)
817                 return GURL::UTF8(file->get_load_name(),init_url.base());
818            }
819            break;
820         case OLD_BUNDLED:
821            if (flags & DOC_DIR_KNOWN)
822            {
823               GP<DjVmDir0::FileRec> frec=djvm_dir0->get_file(id);
824               if (frec)
825                 return GURL::UTF8(id,init_url);
826            }
827            break;
828         case OLD_INDEXED:
829         case SINGLE_PAGE:
830            return GURL::UTF8(id,init_url.base());
831            break;
832      }
833   return GURL();
834}
835
836GURL
837DjVuDocument::id_to_url(const DjVuPort * source, const GUTF8String &id)
838{
839   return id_to_url(id);
840}
841
842GP<DjVuFile>
843DjVuDocument::url_to_file(const GURL & url, bool dont_create) const
844      // This function is private and is called from two places:
845      // id_to_file() and get_djvu_file() ONLY when the structure is known
846{
847   check();
848   DEBUG_MSG("DjVuDocument::url_to_file(): url='" << url << "'\n");
849   DEBUG_MAKE_INDENT(3);
850
851      // Try DjVuPortcaster to find existing files.
852   DjVuPortcaster * pcaster=DjVuPort::get_portcaster();
853   GP<DjVuPort> port;
854
855   if (cache)
856   {
857         // First - fully decoded files
858      port=pcaster->alias_to_port(url.get_string());
859      if (port && port->inherits("DjVuFile"))
860      {
861         DEBUG_MSG("found fully decoded file using DjVuPortcaster\n");
862         return (DjVuFile *) (DjVuPort *) port;
863      }
864   }
865
866      // Second - internal files
867   port=pcaster->alias_to_port(get_int_prefix()+url);
868   if (port && port->inherits("DjVuFile"))
869   {
870      DEBUG_MSG("found internal file using DjVuPortcaster\n");
871      return (DjVuFile *) (DjVuPort *) port;
872   }
873
874   GP<DjVuFile> file;
875   
876   if (!dont_create)
877   {
878      DEBUG_MSG("creating a new file\n");
879      file=DjVuFile::create(url,const_cast<DjVuDocument *>(this),recover_errors,verbose_eof);
880      const_cast<DjVuDocument *>(this)->set_file_aliases(file);
881   }
882
883   return file;
884}
885
886GP<DjVuFile>
887DjVuDocument::get_djvu_file(int page_num, bool dont_create) const
888{
889   check();
890   DEBUG_MSG("DjVuDocument::get_djvu_file(): request for page " << page_num << "\n");
891   DEBUG_MAKE_INDENT(3);
892
893   DjVuPortcaster * pcaster=DjVuPort::get_portcaster();
894   
895   GURL url;
896   {
897         // I'm locking the flags because depending on what page_to_url()
898         // returns me, I'll be creating DjVuFile in different ways.
899         // And I don't want the situation to change between the moment I call
900         // id_to_url() and I actually create DjVuFile
901      GMonitorLock lock(&(const_cast<DjVuDocument *>(this)->flags));
902      url=page_to_url(page_num);
903      if (url.is_empty())
904      {
905            // If init is complete and url is empty, we know for sure, that
906            // smth is wrong with the page_num. So we can return ZERO.
907            // Otherwise we create a temporary file and wait for init to finish
908         if (is_init_complete()) return 0;
909         
910         DEBUG_MSG("Structure is not known => check <doc_url>#<page_num> alias...\n");
911         GP<DjVuPort> port;
912         if (cache)
913            port=pcaster->alias_to_port(init_url.get_string()+"#"+GUTF8String(page_num));
914         if (!port || !port->inherits("DjVuFile"))
915         {
916            DEBUG_MSG("failed => invent dummy URL and proceed\n");
917         
918               // Invent some dummy temporary URL. I don't care what it will
919               // be. I'll remember the page_num and will generate the correct URL
920               // after I learn what the document is
921            GUTF8String name("page");
922            name+=GUTF8String(page_num);
923            name+=".djvu";
924            url=invent_url(name);
925
926            GCriticalSectionLock(&(const_cast<DjVuDocument *>(this)->ufiles_lock));
927            for(GPosition pos=ufiles_list;pos;++pos)
928            {
929               GP<UnnamedFile> f=ufiles_list[pos];
930               if (f->url==url) return f->file;
931            }
932            GP<UnnamedFile> ufile=new UnnamedFile(UnnamedFile::PAGE_NUM, 0,
933                                                  page_num, url, 0);
934
935               // We're adding the record to the list before creating the DjVuFile
936               // because DjVuFile::init() will call request_data(), and the
937               // latter should be able to find the record.
938               //
939               // We also want to keep ufiles_lock to make sure that when
940               // request_data() is called, the record is still there
941            const_cast<DjVuDocument *>(this)->ufiles_list.append(ufile);
942     
943            GP<DjVuFile> file=
944              DjVuFile::create(url,const_cast<DjVuDocument *>(this),recover_errors,verbose_eof);
945            ufile->file=file;
946            return file;
947         } else url=((DjVuFile *) (DjVuPort *) port)->get_url();
948      }
949   }
950   
951   GP<DjVuFile> file=url_to_file(url, dont_create);
952   if (file) 
953     pcaster->add_route(file, const_cast<DjVuDocument *>(this));
954   return file;
955}
956
957GURL
958DjVuDocument::invent_url(const GUTF8String &name) const
959{
960   GUTF8String buffer;
961   buffer.format("djvufileurl://%p/%s", this, (const char *)name);
962   return GURL::UTF8(buffer);
963}
964
965GP<DjVuFile>
966DjVuDocument::get_djvu_file(const GUTF8String& id, bool dont_create)
967{
968  check();
969  DEBUG_MSG("DjVuDocument::get_djvu_file(): ID='" << id << "'\n");
970  DEBUG_MAKE_INDENT(3);
971  if (!id.length())
972    return get_djvu_file(-1);
973
974// Integers are not supported, only ID's 
975//  if (id.is_int())
976//     return get_djvu_file(id.toInt(),dont_create);
977 
978  GURL url;
979  // I'm locking the flags because depending on what id_to_url()
980  // returns me, I'll be creating DjVuFile in different ways.
981  // And I don't want the situation to change between the moment I call
982  // id_to_url() and I actually create DjVuFile
983  {
984    GMonitorLock lock(&flags);
985    url=id_to_url(id);
986    if(url.is_empty() && !id.is_int())
987    {
988      // If init is complete, we know for sure, that there is no such
989      // file with ID 'id' in the document. Otherwise we have to
990      // create a temporary file and wait for the init to finish
991      if (is_init_complete())
992        return 0;
993      // Invent some dummy temporary URL. I don't care what it will
994      // be. I'll remember the ID and will generate the correct URL
995      // after I learn what the document is
996      url=invent_url(id);
997      DEBUG_MSG("Invented url='" << url << "'\n");
998
999      GCriticalSectionLock lock(&ufiles_lock);
1000      for(GPosition pos=ufiles_list;pos;++pos)
1001      {
1002        GP<UnnamedFile> f=ufiles_list[pos];
1003        if (f->url==url)
1004          return f->file;
1005      }
1006      GP<UnnamedFile> ufile=new UnnamedFile(UnnamedFile::ID, id, 0, url, 0);
1007
1008      // We're adding the record to the list before creating the DjVuFile
1009      // because DjVuFile::init() will call request_data(), and the
1010      // latter should be able to find the record.
1011      //
1012      // We also want to keep ufiles_lock to make sure that when
1013      // request_data() is called, the record is still there
1014      ufiles_list.append(ufile);
1015     
1016      GP<DjVuFile> file=DjVuFile::create(url,this,recover_errors,verbose_eof);
1017      ufile->file=file;
1018      return file;
1019    }
1020  }
1021     
1022  return get_djvu_file(url,dont_create);
1023}
1024
1025GP<DjVuFile>
1026DjVuDocument::get_djvu_file(const GURL& url, bool dont_create)
1027{
1028   check();
1029   DEBUG_MSG("DjVuDocument::get_djvu_file(): URL='" << url << "'\n");
1030   DEBUG_MAKE_INDENT(3);
1031
1032   if (url.is_empty())
1033     return 0;
1034
1035   const GP<DjVuFile> file(url_to_file(url, dont_create));
1036
1037   if (file)
1038     get_portcaster()->add_route(file, this);
1039
1040   return file;
1041}
1042
1043GP<DjVuImage>
1044DjVuDocument::get_page(int page_num, bool sync, DjVuPort * port) const
1045{
1046   check();
1047   DEBUG_MSG("DjVuDocument::get_page(): request for page " << page_num << "\n");
1048   DEBUG_MAKE_INDENT(3);
1049
1050   GP<DjVuImage> dimg;
1051   const GP<DjVuFile> file(get_djvu_file(page_num));
1052   if (file)
1053   {
1054     dimg=DjVuImage::create(file);
1055     if (port)
1056       DjVuPort::get_portcaster()->add_route(dimg, port);
1057   
1058     file->resume_decode();
1059     if (dimg && sync)
1060       dimg->wait_for_complete_decode();
1061   }
1062   return dimg;
1063}
1064
1065GP<DjVuImage>
1066DjVuDocument::get_page(const GUTF8String &id, bool sync, DjVuPort * port)
1067{
1068   check();
1069   DEBUG_MSG("DjVuDocument::get_page(): ID='" << id << "'\n");
1070   DEBUG_MAKE_INDENT(3);
1071
1072   GP<DjVuImage> dimg;
1073   const GP<DjVuFile> file(get_djvu_file(id));
1074   if(file)
1075   {
1076     dimg=DjVuImage::create(file);
1077     if (port)
1078       DjVuPort::get_portcaster()->add_route(dimg, port);
1079   
1080     file->resume_decode();
1081     if (dimg && sync)
1082       dimg->wait_for_complete_decode();
1083   }
1084   return dimg;
1085}
1086
1087void
1088DjVuDocument::process_threqs(void)
1089      // Will look thru threqs_list and try to fulfil every request
1090{
1091  GCriticalSectionLock lock(&threqs_lock);
1092  for(GPosition pos=threqs_list;pos;)
1093  {
1094    GP<ThumbReq> req=threqs_list[pos];
1095    bool remove=false;
1096    if (req->thumb_file)
1097    {
1098      G_TRY {
1099               // There is supposed to be a file with thumbnails
1100        if (req->thumb_file->is_data_present())
1101        {
1102          // Cool, we can extract the thumbnail now
1103          GP<ByteStream> str=req->thumb_file->get_init_data_pool()->get_stream();
1104          GP<IFFByteStream> giff=IFFByteStream::create(str);
1105          IFFByteStream &iff=*giff;
1106          GUTF8String chkid;
1107          if (!iff.get_chunk(chkid) || chkid!="FORM:THUM")
1108            G_THROW( ERR_MSG("DjVuDocument.bad_thumb") );         
1109          for(int i=0;i<req->thumb_chunk;i++)
1110          {
1111            if (!iff.get_chunk(chkid)) 
1112              G_THROW( ERR_MSG("DjVuDocument.bad_thumb") );
1113            iff.close_chunk();
1114          }
1115          if (!iff.get_chunk(chkid) || chkid!="TH44")
1116            G_THROW( ERR_MSG("DjVuDocument.bad_thumb") );
1117         
1118          // Copy the data
1119          char buffer[1024];
1120          int length;
1121          while((length=iff.read(buffer, 1024)))
1122            req->data_pool->add_data(buffer, length);
1123          req->data_pool->set_eof();
1124         
1125          // Also add this file to cache so that we won't have
1126          // to download it next time
1127          add_to_cache(req->thumb_file);
1128          req->thumb_file=0;
1129          req->image_file=0;
1130          remove=true;
1131        }
1132      } G_CATCH(exc) {
1133        GUTF8String msg= ERR_MSG("DjVuDocument.cant_extract") "\n";
1134        msg+=exc.get_cause();
1135        get_portcaster()->notify_error(this, msg);
1136               // Switch this request to the "decoding" mode
1137        req->image_file=get_djvu_file(req->page_num);
1138        req->thumb_file=0;
1139        req->data_pool->set_eof();
1140        remove=true;
1141      } G_ENDCATCH;
1142    } // if (req->thumb_file)
1143   
1144    if (req->image_file)
1145    {
1146      G_TRY {
1147               // Decode the file if necessary. Or just used predecoded image.
1148        GSafeFlags & file_flags=req->image_file->get_safe_flags();
1149        {
1150          GMonitorLock lock(&file_flags);
1151          if (!req->image_file->is_decoding())
1152          {
1153            if (req->image_file->is_decode_ok())
1154            {
1155              // We can generate it now
1156              const GP<DjVuImage> dimg(DjVuImage::create(req->image_file));
1157             
1158              dimg->wait_for_complete_decode();
1159             
1160              int width = 160;
1161              int height = 160;
1162             
1163              if( dimg->get_width() )
1164                width = dimg->get_width();
1165              if( dimg->get_height() )
1166                height = dimg->get_height();
1167             
1168              GRect rect(0, 0, 160, height*160/width);
1169              GP<GPixmap> pm=dimg->get_pixmap(rect, rect, thumb_gamma);
1170              if (!pm)
1171              {
1172                GP<GBitmap> bm=dimg->get_bitmap(rect, rect, sizeof(int));
1173                if(bm)
1174                  pm=GPixmap::create(*bm);
1175                else
1176                  pm = GPixmap::create(rect.height(), rect.width(), 
1177                                       &GPixel::WHITE);
1178              }
1179             
1180              // Store and compress the pixmap
1181              GP<IW44Image> iwpix=IW44Image::create_encode(*pm);
1182              GP<ByteStream> gstr=ByteStream::create();
1183              IWEncoderParms parms;
1184              parms.slices=97;
1185              parms.bytes=0;
1186              parms.decibels=0;
1187              iwpix->encode_chunk(gstr, parms);
1188              TArray<char> data=gstr->get_data();
1189             
1190              req->data_pool->add_data((const char *) data, data.size());
1191              req->data_pool->set_eof();
1192             
1193              req->thumb_file=0;
1194              req->image_file=0;
1195              remove=true;
1196            } else if (req->image_file->is_decode_failed())
1197            {
1198              // Unfortunately we cannot decode it
1199              req->thumb_file=0;
1200              req->image_file=0;
1201              req->data_pool->set_eof();
1202              remove=true;
1203            } else
1204            {
1205              req->image_file->start_decode();
1206            }
1207          }
1208        }
1209      } G_CATCH(exc) {
1210        GUTF8String msg="Failed to decode thumbnails:\n";
1211        msg+=exc.get_cause();
1212        get_portcaster()->notify_error(this, msg);
1213       
1214               // Get rid of this request
1215        req->image_file=0;
1216        req->thumb_file=0;
1217        req->data_pool->set_eof();
1218        remove=true;
1219      } G_ENDCATCH;
1220    }
1221   
1222    if (remove)
1223    {
1224      GPosition this_pos=pos;
1225      ++pos;
1226      threqs_list.del(this_pos);
1227    } else ++pos;
1228  }
1229}
1230
1231GP<DjVuDocument::ThumbReq>
1232DjVuDocument::add_thumb_req(const GP<ThumbReq> & thumb_req)
1233      // Will look through the list of pending requests for thumbnails
1234      // and try to add the specified request. If a duplicate is found,
1235      // it will be returned and the list will not be modified
1236{
1237   GCriticalSectionLock lock(&threqs_lock);
1238   for(GPosition pos=threqs_list;pos;++pos)
1239   {
1240      GP<ThumbReq> req=threqs_list[pos];
1241      if (req->page_num==thumb_req->page_num)
1242         return req;
1243   }
1244   threqs_list.append(thumb_req);
1245   return thumb_req;
1246}
1247
1248GList<GUTF8String>
1249DjVuDocument::get_id_list(void)
1250{
1251  GList<GUTF8String> ids;
1252  if (is_init_complete())
1253  {
1254    if(djvm_dir)
1255    {
1256      GPList<DjVmDir::File> files_list=djvm_dir->get_files_list();
1257      for(GPosition pos=files_list;pos;++pos)
1258      {
1259        ids.append(files_list[pos]->get_load_name());
1260      }
1261    }else
1262    {
1263      const int page_num=get_pages_num();
1264      for(int page=0;page<page_num;page++)
1265      { 
1266        ids.append(page_to_url(page).fname());
1267      }
1268    }
1269  }
1270  return ids;
1271}
1272
1273void
1274DjVuDocument::map_ids(GMap<GUTF8String,void *> &map)
1275{
1276  GList<GUTF8String> ids=get_id_list();
1277  for(GPosition pos=ids;pos;++pos)
1278  {
1279    map[ids[pos]]=0;
1280  }
1281}
1282
1283GP<DataPool>
1284DjVuDocument::get_thumbnail(int page_num, bool dont_decode)
1285{
1286   DEBUG_MSG("DjVuDocument::get_thumbnail(): page_num=" << page_num << "\n");
1287   DEBUG_MAKE_INDENT(3);
1288
1289   if (!is_init_complete()) return 0;
1290   
1291   {
1292         // See if we already have request for this thumbnail pending
1293      GCriticalSectionLock lock(&threqs_lock);
1294      for(GPosition pos=threqs_list;pos;++pos)
1295      {
1296         GP<ThumbReq> req=threqs_list[pos];
1297         if (req->page_num==page_num)
1298            return req->data_pool;      // That's it. Just return it.
1299      }
1300   }
1301
1302      // No pending request for this page... Create one
1303   GP<ThumbReq> thumb_req=new ThumbReq(page_num, DataPool::create());
1304   
1305      // First try to find predecoded thumbnail
1306   if (get_doc_type()==INDIRECT || get_doc_type()==BUNDLED)
1307   {
1308         // Predecoded thumbnails exist for new formats only
1309      GPList<DjVmDir::File> files_list=djvm_dir->get_files_list();
1310      GP<DjVmDir::File> thumb_file;
1311      int thumb_start=0;
1312      int page_cnt=-1;
1313      for(GPosition pos=files_list;pos;++pos)
1314      {
1315         GP<DjVmDir::File> f=files_list[pos];
1316         if (f->is_thumbnails())
1317         {
1318            thumb_file=f;
1319            thumb_start=page_cnt+1;
1320         } else if (f->is_page())
1321         {
1322           page_cnt++;
1323         }
1324         if (page_cnt==page_num) break;
1325      }
1326      if (thumb_file)
1327      {
1328            // That's the file with the desired thumbnail image
1329         thumb_req->thumb_file=get_djvu_file(thumb_file->get_load_name());
1330         thumb_req->thumb_chunk=page_num-thumb_start;
1331         thumb_req=add_thumb_req(thumb_req);
1332         process_threqs();
1333         return thumb_req->data_pool;
1334      }
1335   }
1336
1337      // Apparently we're out of luck and need to decode the requested
1338      // page (unless it's already done and if it's allowed) and render
1339      // it into the thumbnail. If dont_decode is true, do not attempt
1340      // to create this file (because this will result in a request for data)
1341   GP<DjVuFile> file=get_djvu_file(page_num, dont_decode);
1342   if (file)
1343   {
1344      thumb_req->image_file=file;
1345
1346         // I'm locking the flags here to make sure, that DjVuFile will not
1347         // change its state in between of the checks.
1348      GSafeFlags & file_flags=file->get_safe_flags();
1349      {
1350         GMonitorLock lock(&file_flags);
1351         if (thumb_req->image_file->is_decode_ok() || !dont_decode)
1352         {
1353               // Just add it to the list and call process_threqs(). It
1354               // will start decoding if necessary
1355            thumb_req=add_thumb_req(thumb_req);
1356            process_threqs();
1357         } else
1358         {
1359               // Nothing can be done return ZERO
1360            thumb_req=0;
1361         }
1362      }
1363   } else thumb_req=0;
1364   
1365   if (thumb_req) return thumb_req->data_pool;
1366   else return 0;
1367}
1368
1369static void
1370add_to_cache(const GP<DjVuFile> & f, GMap<GURL, void *> & map,
1371             DjVuFileCache * cache)
1372{
1373   GURL url=f->get_url();
1374   DEBUG_MSG("DjVuDocument::add_to_cache(): url='" << url << "'\n");
1375   DEBUG_MAKE_INDENT(3);
1376   
1377   if (!map.contains(url))
1378   {
1379      map[url]=0;
1380      cache->add_file(f);
1381     
1382      GPList<DjVuFile> list;
1383      for(GPosition pos=list;pos;++pos)
1384         add_to_cache(list[pos], map, cache);
1385   }
1386}
1387
1388void
1389DjVuDocument::add_to_cache(const GP<DjVuFile> & f)
1390{
1391   if (cache)
1392   {
1393      GMap<GURL, void *> map;
1394      ::add_to_cache(f, map, cache);
1395   }
1396}
1397
1398void
1399DjVuDocument::notify_file_flags_changed(const DjVuFile * source,
1400                                        long set_mask, long clr_mask)
1401{
1402      // Don't check here if the document is initialized or not.
1403      // This function may be called when it's not.
1404      // check();
1405   if (set_mask & DjVuFile::DECODE_OK)
1406   {
1407      set_file_aliases(source);
1408      if (cache) add_to_cache((DjVuFile *) source);
1409      if(!needs_compression_flag)
1410      {
1411        if(source->needs_compression())
1412        {
1413          can_compress_flag=true;
1414          needs_compression_flag=true;
1415        }else if(source->can_compress())
1416        {
1417          can_compress_flag=true;
1418        }
1419      }
1420   }
1421   process_threqs();
1422}
1423
1424GP<DjVuFile>
1425DjVuDocument::id_to_file(const DjVuPort * source, const GUTF8String &id)
1426{
1427   return (DjVuFile *) get_djvu_file(id);
1428}
1429
1430GP<DataPool>
1431DjVuDocument::request_data(const DjVuPort * source, const GURL & url)
1432{
1433   DEBUG_MSG("DjVuDocument::request_data(): seeing if we can do it\n");
1434   DEBUG_MAKE_INDENT(3);
1435
1436   if (url==init_url)
1437     return init_data_pool;
1438
1439   check();     // Don't put it before 'init_data_pool'
1440
1441   {
1442         // See if there is a file in the "UnnamedFiles" list.
1443         // If it's there, then create an empty DataPool and store its
1444         // pointer in the list. The "init thread" will eventually
1445         // do smth with it.
1446      GCriticalSectionLock lock(&ufiles_lock);
1447      for(GPosition pos=ufiles_list;pos;++pos)
1448      {
1449         GP<UnnamedFile> f=ufiles_list[pos];
1450         if (f->url==url)
1451         {
1452            DEBUG_MSG("Found tmp unnamed DjVuFile. Return empty DataPool\n");
1453               // Remember the DataPool. We will connect it to the
1454               // actual data after the document structure becomes known
1455            f->data_pool=DataPool::create();
1456            return f->data_pool;
1457         }
1458      }
1459   }
1460
1461      // Well, the url is not in the "UnnamedFiles" list, but it doesn't
1462      // mean, that it's not "artificial". Stay alert!
1463   GP<DataPool> data_pool;
1464   if (flags & DOC_TYPE_KNOWN)
1465      switch(doc_type)
1466      {
1467         case OLD_BUNDLED:
1468         {
1469            if (flags & DOC_DIR_KNOWN)
1470            {
1471               DEBUG_MSG("The document is in OLD_BUNDLED format\n");
1472               if (url.base()!=init_url)
1473                        G_THROW( ERR_MSG("DjVuDocument.URL_outside") "\t"+url.get_string());
1474         
1475               GP<DjVmDir0::FileRec> file=djvm_dir0->get_file(url.fname());
1476               if (!file)
1477               {
1478                 G_THROW( ERR_MSG("DjVuDocument.file_outside") "\t"+url.fname());
1479               }
1480               data_pool=DataPool::create(init_data_pool, file->offset, file->size);
1481            }
1482            break;
1483         }
1484         case BUNDLED:
1485         {
1486            if (flags & DOC_DIR_KNOWN)
1487            {
1488               DEBUG_MSG("The document is in new BUNDLED format\n");
1489               if (url.base()!=init_url)
1490               {
1491                 G_THROW( ERR_MSG("DjVuDocument.URL_outside") "\t"
1492                   +url.get_string());
1493               }
1494         
1495               GP<DjVmDir::File> file=djvm_dir->id_to_file(url.fname());
1496               if (!file)
1497               {
1498                 G_THROW( ERR_MSG("DjVuDocument.file_outside") "\t"+url.fname());
1499               }
1500               data_pool=DataPool::create(init_data_pool, file->offset, file->size);
1501            }
1502            break;
1503         }
1504         case SINGLE_PAGE:
1505         case OLD_INDEXED:
1506         case INDIRECT:
1507         {
1508            DEBUG_MSG("The document is in SINGLE_PAGE or OLD_INDEXED or INDIRECT format\n");
1509            if (flags & DOC_DIR_KNOWN)
1510               if (doc_type==INDIRECT && !djvm_dir->id_to_file(url.fname()))
1511                        G_THROW( ERR_MSG("DjVuDocument.URL_outside2") "\t"+url.get_string());
1512         
1513            if (url.is_local_file_url())
1514            {
1515//             GUTF8String fname=GOS::url_to_filename(url);
1516//             if (GOS::basename(fname)=="-") fname="-";
1517               DEBUG_MSG("url=" << url << "\n");
1518
1519               data_pool=DataPool::create(url);
1520            }
1521         }
1522      }
1523   return data_pool;
1524}
1525
1526
1527static void
1528add_file_to_djvm(const GP<DjVuFile> & file, bool page,
1529                 DjVmDoc & doc, GMap<GURL, void *> & map)
1530      // This function is used only for obsolete formats.
1531      // For new formats there is no need to process files recursively.
1532      // All information is already available from the DJVM chunk
1533{
1534   GURL url=file->get_url();
1535
1536   if (!map.contains(url))
1537   {
1538      map[url]=0;
1539
1540      if (file->get_chunks_number()>0 && !file->contains_chunk("NDIR"))
1541      {
1542            // Get the data and unlink any file containing NDIR chunk.
1543            // Yes. We're lazy. We don't check if those files contain
1544            // anything else.
1545         GPosition pos;
1546         GPList<DjVuFile> files_list=file->get_included_files(false);
1547         GP<DataPool> data=file->get_djvu_data(false);
1548         for(pos=files_list;pos;++pos)
1549         {
1550            GP<DjVuFile> f=files_list[pos];
1551            if (f->contains_chunk("NDIR"))
1552               data=DjVuFile::unlink_file(data, f->get_url().fname());
1553         }
1554         
1555            // Finally add it to the document
1556         GUTF8String name=file->get_url().fname();
1557         GP<DjVmDir::File> file_rec=DjVmDir::File::create(
1558           name, name, name,
1559           page ? DjVmDir::File::PAGE : DjVmDir::File::INCLUDE );
1560         doc.insert_file(file_rec, data, -1);
1561
1562            // And repeat for all included files
1563         for(pos=files_list;pos;++pos)
1564            add_file_to_djvm(files_list[pos], false, doc, map);
1565      }
1566   }
1567}
1568
1569static void
1570add_file_to_djvm(const GP<DjVuFile> & file, bool page,
1571                 DjVmDoc & doc, GMap<GURL, void *> & map, 
1572                 bool &needs_compression_flag, bool &can_compress_flag )
1573{
1574  if(!needs_compression_flag)
1575  {
1576    if(file->needs_compression())
1577    {
1578      can_compress_flag=true;
1579      needs_compression_flag=true;
1580    }else if(file->can_compress())
1581    {
1582      can_compress_flag=true;
1583    }
1584  }
1585  add_file_to_djvm(file,page,doc,map);
1586}
1587
1588static void
1589local_get_url_names(DjVuFile * f,const GMap<GURL, void *> & map,GMap<GURL,void *> &tmpmap)
1590{
1591   GURL url=f->get_url();
1592   if (!map.contains(url) && !tmpmap.contains(url))
1593   {
1594      tmpmap[url]=0;
1595      f->process_incl_chunks();
1596      GPList<DjVuFile> files_list=f->get_included_files(false);
1597      for(GPosition pos=files_list;pos;++pos)
1598         local_get_url_names(files_list[pos], map, tmpmap);
1599   }
1600}
1601
1602static void
1603local_get_url_names(DjVuFile * f, GMap<GURL, void *> & map)
1604{
1605   GMap<GURL,void *> tmpmap;
1606   local_get_url_names(f,map,tmpmap);
1607   for(GPosition pos=tmpmap;pos;++pos)
1608     map[tmpmap.key(pos)]=0;
1609}
1610
1611GList<GURL>
1612DjVuDocument::get_url_names(void)
1613{
1614  check();
1615
1616  GCriticalSectionLock lock(&url_names_lock);
1617  if(has_url_names)
1618    return url_names;
1619
1620  GMap<GURL, void *> map;
1621  int i;
1622  if (doc_type==BUNDLED || doc_type==INDIRECT)
1623  {
1624    GPList<DjVmDir::File> files_list=djvm_dir->get_files_list();
1625    for(GPosition pos=files_list;pos;++pos)
1626    {
1627      GURL url=id_to_url(files_list[pos]->get_load_name());
1628      map[url]=0;
1629    }
1630  }else
1631  {
1632    int pages_num=get_pages_num();
1633    for(i=0;i<pages_num;i++)
1634    {
1635      G_TRY
1636      {
1637        local_get_url_names(get_djvu_file(i), map);
1638      }
1639      G_CATCH(ex)
1640      {
1641        // Why is this try/catch block here?
1642        G_TRY { 
1643          get_portcaster()->notify_error(this, ex.get_cause()); 
1644          GUTF8String emsg = ERR_MSG("DjVuDocument.exclude_page") "\t" + (i+1);
1645          get_portcaster()->notify_error(this, emsg);
1646        }
1647        G_CATCH_ALL
1648        {
1649          G_RETHROW;
1650        }
1651        G_ENDCATCH;
1652      }
1653      G_ENDCATCH;
1654    }
1655  }
1656  for(GPosition j=map;j;++j)
1657  {
1658    if (map.key(j).is_local_file_url())
1659    {
1660      url_names.append(map.key(j));
1661    }
1662  }
1663  has_url_names=true;
1664  return url_names;
1665}
1666
1667GP<DjVmDoc>
1668DjVuDocument::get_djvm_doc()
1669      // This function may block for data
1670{
1671   check();
1672   DEBUG_MSG("DjVuDocument::get_djvm_doc(): creating the DjVmDoc\n");
1673   DEBUG_MAKE_INDENT(3);
1674
1675   if (!is_init_complete())
1676     G_THROW( ERR_MSG("DjVuDocument.init_not_done") );
1677
1678   GP<DjVmDoc> doc=DjVmDoc::create();
1679
1680   if (doc_type==BUNDLED || doc_type==INDIRECT)
1681     {
1682       GPList<DjVmDir::File> files_list=djvm_dir->get_files_list();
1683       for(GPosition pos=files_list;pos;++pos)
1684         {
1685           GP<DjVmDir::File> f=new DjVmDir::File(*files_list[pos]);
1686           GP<DjVuFile> file=url_to_file(id_to_url(f->get_load_name()));
1687           GP<DataPool> data;
1688           if (file->is_modified()) 
1689             data=file->get_djvu_data(false);
1690           else 
1691             data=file->get_init_data_pool();
1692           doc->insert_file(f, data);
1693         }
1694       if (djvm_nav)
1695         doc->set_djvm_nav(djvm_nav);
1696     } 
1697   else if (doc_type==SINGLE_PAGE)
1698     {
1699       DEBUG_MSG("Creating: djvm for a single page document.\n");
1700       GMap<GURL, void *> map_add;
1701       GP<DjVuFile> file=get_djvu_file(0);
1702       add_file_to_djvm(file, true, *doc, map_add,
1703                        needs_compression_flag,can_compress_flag);
1704     } 
1705   else
1706     {
1707       DEBUG_MSG("Converting: the document is in an old format.\n");
1708       GMap<GURL, void *> map_add;
1709       if(recover_errors == ABORT)
1710         {
1711           for(int page_num=0;page_num<ndir->get_pages_num();page_num++)
1712             {
1713               GP<DjVuFile> file=url_to_file(ndir->page_to_url(page_num));
1714               add_file_to_djvm(file, true, *doc, map_add,
1715                                needs_compression_flag,can_compress_flag);
1716             }
1717         }
1718       else
1719         {
1720           for(int page_num=0;page_num<ndir->get_pages_num();page_num++)
1721             {
1722               G_TRY
1723                 {
1724                   GP<DjVuFile> file=url_to_file(ndir->page_to_url(page_num));
1725                   add_file_to_djvm(file, true, *doc, map_add,
1726                                    needs_compression_flag,can_compress_flag);
1727                 }
1728               G_CATCH(ex)
1729                 {
1730                   G_TRY { 
1731                     get_portcaster()->notify_error(this, ex.get_cause());
1732                     GUTF8String emsg = ERR_MSG("DjVuDocument.skip_page") "\t" 
1733                                      + (page_num+1);
1734                     get_portcaster()->notify_error(this, emsg);
1735                   }
1736                   G_CATCH_ALL
1737                     {
1738                       G_RETHROW;
1739                     }
1740                   G_ENDCATCH;
1741                 }
1742               G_ENDCATCH;
1743             }
1744         }
1745     }
1746   return doc;
1747}
1748
1749void
1750DjVuDocument::write( const GP<ByteStream> &gstr,
1751  const GMap<GUTF8String,void *> &reserved)
1752{
1753  DEBUG_MSG("DjVuDocument::write(): storing DjVmDoc into ByteStream\n");
1754  DEBUG_MAKE_INDENT(3);
1755  get_djvm_doc()->write(gstr,reserved); 
1756}
1757
1758void
1759DjVuDocument::write(const GP<ByteStream> &gstr, bool force_djvm)
1760{
1761  DEBUG_MSG("DjVuDocument::write(): storing DjVmDoc into ByteStream\n");
1762  DEBUG_MAKE_INDENT(3);
1763   
1764  GP<DjVmDoc> doc=get_djvm_doc();
1765  GP<DjVmDir> dir=doc->get_djvm_dir();
1766  if (force_djvm || dir->get_files_num()>1)
1767  {
1768    doc->write(gstr);
1769  }else
1770  {
1771    GPList<DjVmDir::File> files_list=dir->resolve_duplicates(false);
1772    GP<DataPool> pool=doc->get_data(files_list[files_list]->get_load_name());
1773    GP<ByteStream> pool_str=pool->get_stream();
1774    ByteStream &str=*gstr;
1775    str.writall(octets,4);
1776    str.copy(*pool_str);
1777  }
1778}
1779
1780void
1781DjVuDocument::expand(const GURL &codebase, const GUTF8String &idx_name)
1782{
1783   DEBUG_MSG("DjVuDocument::expand(): codebase='" << codebase << "'\n");
1784   DEBUG_MAKE_INDENT(3);
1785   
1786   GP<DjVmDoc> doc=get_djvm_doc();
1787   doc->expand(codebase, idx_name);
1788}
1789
1790void
1791DjVuDocument::save_as(const GURL &where, const bool bundled)
1792{
1793   DEBUG_MSG("DjVuDocument::save_as(): where='" << where <<
1794             "', bundled=" << bundled << "\n");
1795   DEBUG_MAKE_INDENT(3);
1796   
1797   if (needs_compression())
1798   { 
1799     if(!djvu_compress_codec)
1800     {
1801       G_THROW( ERR_MSG("DjVuDocument.comp_codec") );
1802     }
1803     GP<ByteStream> gmbs=ByteStream::create();
1804     write(gmbs);
1805     ByteStream &mbs=*gmbs;
1806     mbs.flush();
1807     mbs.seek(0,SEEK_SET);
1808     (*djvu_compress_codec)(gmbs,where,bundled);
1809   }else if (bundled)
1810   {
1811      DataPool::load_file(where);
1812      write(ByteStream::create(where, "wb"));
1813   } else 
1814   {
1815     expand(where.base(), where.fname());
1816   }
1817}
1818
1819static const char prolog[]="<?xml version=\"1.0\" ?>\n<!DOCTYPE DjVuXML PUBLIC \"-//W3C//DTD DjVuXML 1.1//EN\" \"pubtext/DjVuXML-s.dtd\">\n<DjVuXML>\n<HEAD>";
1820static const char start_xml[]="</HEAD>\n<BODY>\n";
1821static const char end_xml[]="</BODY>\n</DjVuXML>\n";
1822
1823void
1824DjVuDocument::writeDjVuXML(const GP<ByteStream> &gstr_out,int flags) const
1825{
1826  ByteStream &str_out=*gstr_out;
1827  str_out.writestring(
1828    prolog+get_init_url().get_string().toEscaped()+start_xml);
1829  const int pages=wait_get_pages_num();
1830  for(int page_num=0;page_num<pages;++page_num)
1831  {
1832    const GP<DjVuImage> dimg(get_page(page_num,true));
1833    if(!dimg)
1834    {
1835      G_THROW( ERR_MSG("DjVuToText.decode_failed") );
1836    }
1837    dimg->writeXML(str_out,get_init_url(),flags);
1838  }
1839  str_out.writestring(GUTF8String(end_xml));
1840}
1841
1842
1843#ifdef HAVE_NAMESPACES
1844}
1845# ifndef NOT_USING_DJVU_NAMESPACE
1846using namespace DJVU;
1847# endif
1848#endif
Note: See TracBrowser for help on using the repository browser.