home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 2 / Apprentice-Release2.iso / Source Code / C++ / Applications / Nuntius 1.2 / src / Nuntius / UArticleTextCache.cp < prev    next >
Encoding:
Text File  |  1994-02-20  |  5.9 KB  |  242 lines  |  [TEXT/MPS ]
  1. // Copyright © 1992 Peter Speck, speck@dat.ruc.dk. All rights reserved.
  2. // UArticleTextCache.cp
  3.  
  4. #include "UArticleTextCache.h"
  5. #include "UNntp.h"
  6. #include "UGroupDoc.h"
  7. #include "UPrefsDatabase.h"
  8. #include "Tools.h"
  9.  
  10. #include <RsrcGlobals.h>
  11. #include <Folders.h>
  12.  
  13. #pragma segment MyArticle
  14.  
  15. #define qDebugCache qDebug & 0
  16. #define qDebugCacheIntense qDebug & 0
  17.  
  18. PArticleTextCache *gArticleTextCache = nil;
  19.  
  20. //------------------------------------------------------
  21. ArticleEntry::ArticleEntry()
  22. {
  23. }
  24.  
  25. //------------------------------------------------------
  26. PArticleTextCache::PArticleTextCache()
  27. {
  28. //    inherited::Initialize();
  29.     fInIndex = 0;
  30.     fOutIndex = fInIndex + 1;
  31.     fLastUsedIndex = 0;
  32.     fNoUsedEntries = 0;
  33.     fSumSize = 0;
  34.     for (short i = 0; i < kMaxNoCachedArticleTexts; i++)
  35.     {
  36.         fArticleTable[i].fID = -1;
  37.         fArticleTable[i].fH = nil;
  38.         fArticleTable[i].fSize = 0;
  39.     }
  40. }
  41.  
  42. void PArticleTextCache::IArticleTextCache()
  43. {
  44. //    inherited::IObject();
  45. }
  46.  
  47. PArticleTextCache::~PArticleTextCache()
  48. {
  49.     for (short i = 0; i < kMaxNoCachedArticleTexts; i++)
  50.     {
  51.         DisposeIfHandle(fArticleTable[i].fH);
  52.     }
  53. //    inherited::Free();
  54. }
  55.  
  56. inline void GoNextEntry(short &index)
  57. { 
  58.     if (index == kMaxNoCachedArticleTexts - 1)
  59.         index = 0;
  60.     else
  61.         index++;
  62. }
  63.  
  64. inline void GoPrevEntry(short &index)
  65. {
  66.     if (index)
  67.         index--;
  68.     else
  69.         index = kMaxNoCachedArticleTexts - 1;
  70. }
  71.  
  72. void PArticleTextCache::FlushOneArticle()
  73. {
  74.     ArticleEntryPtr aeP = fArticleTable + fOutIndex;
  75. #if qDebug
  76. //    Boolean prevLock = Lock(true);
  77. #if qDebugCache
  78.     fprintf(stderr, "PArticleTextCache: Flushing, id = %ld, size = %ld, handle = %lx, fSumSize = %ld\n", aeP->fID, aeP->fSize, aeP->fH, fSumSize);
  79. #endif
  80.     if (!IsHandle(aeP->fH))
  81.     {
  82.         ProgramBreak("The article handle is not valid (flushing)\n");
  83.         aeP->fH = nil;
  84.     }
  85. //    Lock(prevLock);
  86. #endif
  87.     Handle h = aeP->fH;  // wait with m-mgr until done with Pointer
  88.     aeP->fH = nil;
  89.     fSumSize -= aeP->fSize;
  90.     aeP->fSize = 0;
  91.     aeP->fID = -1;
  92.     if (h)
  93.         DisposeHandle(h);
  94.     fNoUsedEntries--;
  95.     GoNextEntry(fOutIndex);
  96.     fLastUsedIndex = fInIndex;
  97. }
  98.  
  99. void PArticleTextCache::FlushToFit(const long maxSumSize)
  100. {
  101.     while (fSumSize > maxSumSize || fNoUsedEntries >= kMaxNoCachedArticleTexts)
  102.     {
  103.         FlushOneArticle();
  104.     } // while
  105. }
  106.  
  107. Handle PArticleTextCache::GetArticleFromNntp(const CStr255 &groupDotName, long id)
  108. {
  109.     FlushToFit(gPrefs->GetLongPrefs('AMem'));
  110.     PNntp *nntp = gNntpCache->GetNntp();
  111.     Handle h = nil;
  112.     FailInfo fi;
  113.     if (fi.Try())
  114.     {
  115.         nntp->SetGroup(groupDotName);
  116.         h = nntp->GetArticle(id);
  117.         fi.Success();
  118.     }
  119.     else // fail
  120.     {
  121.         gNntpCache->DiscardNntp(nntp);
  122.         fi.ReSignal();
  123.     }
  124.     gNntpCache->ReturnNntp(nntp); nntp = nil;
  125. #if qDebug
  126.     if (!h)
  127.         ProgramBreak("PNntp returned _NIL_ article handle to PArticleTextCache");
  128. #endif
  129.     GoNextEntry(fInIndex);
  130.     if (!fNoUsedEntries)
  131.     {
  132. #if qDebug
  133.         if (fInIndex != fOutIndex)
  134.             ProgramBreak("misalign between fInIndex and fOutIndex");
  135. #endif
  136.         fOutIndex = fInIndex;
  137.     }
  138.     fNoUsedEntries++;
  139. #if qDebugCacheIntense
  140.     fprintf(stderr, "PArticleTextCache, got article group = %s, ID = %ld from nntp\n", (char*)groupDotName, id);
  141.     fprintf(stderr, "-   put in cache with index = %ld, size = %ld\n", fInIndex, GetHandleSize(h));
  142. #endif
  143.     fArticleTable[fInIndex].fID = id;
  144.     fArticleTable[fInIndex].fGroupDotName = groupDotName;
  145.     fArticleTable[fInIndex].fH = h;
  146.     long size = GetHandleSize(h);
  147.     fSumSize += size;
  148.     fArticleTable[fInIndex].fSize = size;
  149.     fLastUsedIndex = fInIndex;
  150. #if qDebug
  151.         ArticleEntryPtr aeP = fArticleTable + fInIndex;
  152. //        Boolean prevLock = Lock(true);
  153. #if qDebugCache
  154.         fprintf(stderr, "PArticleTextCache: new article id = %ld, size = %ld, handle = 0x%lx\n", aeP->fID, aeP->fSize, aeP->fH);
  155. #endif
  156.         if (!IsHandle(aeP->fH))
  157.             ProgramBreak("The article handle is not valid (obtained from nntp)\n");
  158. //        Lock(prevLock);
  159. #endif
  160.     return h;
  161. }
  162.  
  163. Handle PArticleTextCache::GetArticleText(const CStr255 &groupDotName, long id)
  164. {
  165. #if qDebugCacheIntense
  166.     fprintf(stderr, "PArticleTextCache::GetArticle, group = %s, ID = %ld\n", (char*)groupDotName, id);
  167. #endif
  168.     // was it the last one?
  169.     if (fNoUsedEntries && id == fArticleTable[fLastUsedIndex].fID && groupDotName == fArticleTable[fLastUsedIndex].fGroupDotName)
  170.     {
  171. #if qDebugCacheIntense
  172.         fprintf(stderr, "-  found article as last used with index = %ld\n", fLastUsedIndex);
  173. #endif
  174.         return fArticleTable[fLastUsedIndex].fH;
  175.     }
  176.     // else try go seek for it
  177.     short index = fInIndex;
  178.     for (short i = 1; i <= kMaxNoCachedArticleTexts; i++)
  179.     {
  180.         if (id == fArticleTable[index].fID && groupDotName == fArticleTable[index].fGroupDotName)
  181.         {
  182. #if qDebugCacheIntense
  183.             fprintf(stderr, "-  found article with index = %ld, fLastUsedIndex = %ld\n", i, fLastUsedIndex);
  184. #endif
  185.             fLastUsedIndex = index;
  186.             return fArticleTable[index].fH; // found it
  187.         }
  188.         GoPrevEntry(index);
  189.     }
  190. #if qDebugCacheIntense
  191.     fprintf(stderr, "-  did not find article, fetches it from nntp\n");
  192. #endif
  193.     return GetArticleFromNntp(groupDotName, id);
  194. }
  195.  
  196. void PArticleTextCache::FlushCache()
  197. {
  198.     while (fNoUsedEntries)
  199.         FlushOneArticle();
  200. }
  201.  
  202. void InitUArticleTextCache()
  203. {
  204. #if qDebug
  205.     if (gArticleTextCache)
  206.         ProgramBreak("InitUArticleTextCache is called twice");
  207. #endif
  208.     PArticleTextCache *ac = new PArticleTextCache();
  209.     ac->IArticleTextCache();
  210.     gArticleTextCache = ac;
  211. }
  212.  
  213. void CloseDownUArticleTextCache()
  214. {
  215. #if qDebug
  216.     if (!gArticleTextCache)
  217.         fprintf(stderr, "gArticleTextCache is nil in CloseDownUArticleTextCache\n");
  218. #endif
  219.     FreeIfPtrObject(gArticleTextCache);     gArticleTextCache = nil;
  220. }
  221.  
  222. void PArticleTextCache::DebugDump()
  223. {
  224. #if qDebug
  225.     fprintf(stderr, "Debug dump of article text cache:\n");
  226.     short index = fInIndex;
  227.     for (short i = 1; i <= kMaxNoCachedArticleTexts; i++)
  228.     {
  229.         ArticleEntry entry;
  230.         BytesMove(fArticleTable + index, &entry, sizeof(entry));
  231.         if (entry.fID >= 0)
  232.         {
  233.             fprintf(stderr, "   index = %ld, group = %s, ID = %ld, size = %ld, handle = $%lx\n",
  234.                 i, (char*)entry.fGroupDotName, entry.fID, entry.fSize, entry.fH);
  235.             if (!IsHandle(entry.fH))
  236.                 fprintf(stderr, "    *** This handle is not valid\n");
  237.         }
  238.         GoPrevEntry(index);
  239.     }
  240. #endif
  241. }
  242.