4 * @brief Implementation of DirScan (q.v.) and helper functions
11 #define POCO_NO_UNWINDOWS 1
12 #include <Poco/Semaphore.h>
13 #include <Poco/Notification.h>
14 #include <Poco/NotificationQueue.h>
15 #include <Poco/Environment.h>
16 #include <Poco/ThreadPool.h>
17 #include <Poco/Thread.h>
18 #include <Poco/Runnable.h>
19 #include <Poco/Mutex.h>
20 #include <Poco/AutoPtr.h>
21 #include <Poco/Stopwatch.h>
22 #include <Poco/Format.h>
23 #include "DiffThread.h"
24 #include "UnicodeString.h"
25 #include "DiffWrapper.h"
26 #include "CompareStats.h"
27 #include "FolderCmp.h"
28 #include "FileFilterHelper.h"
29 #include "IAbortable.h"
31 #include "DirTravel.h"
35 #include "OptionsDef.h"
36 #include "OptionsMgr.h"
37 #include "PathContext.h"
40 using Poco::NotificationQueue;
41 using Poco::Notification;
44 using Poco::ThreadPool;
46 using Poco::Environment;
47 using Poco::Stopwatch;
49 // Static functions (ie, functions only used locally)
50 static void CompareDiffItem(FolderCmp &fc, DIFFITEM &di);
51 static DIFFITEM *AddToList(const String &sLeftDir, const String &sRightDir, const DirItem *lent, const DirItem *rent,
52 unsigned code, DiffFuncStruct *myStruct, DIFFITEM *parent);
53 static DIFFITEM *AddToList(const String &sDir1, const String &sDir2, const String &sDir3, const DirItem *ent1, const DirItem *ent2, const DirItem *ent3,
54 unsigned code, DiffFuncStruct *myStruct, DIFFITEM *parent, int nItems = 3);
55 static void UpdateDiffItem(DIFFITEM &di, bool &bExists, CDiffContext *pCtxt);
56 static int CompareItems(NotificationQueue &queue, DiffFuncStruct *myStruct, DIFFITEM *parentdiffpos);
57 static unsigned GetDirCompareFlags3Way(const DIFFITEM& di);
59 class WorkNotification: public Poco::Notification
62 WorkNotification(DIFFITEM& di, NotificationQueue& queueResult): m_di(di), m_queueResult(queueResult) {}
63 DIFFITEM& data() const { return m_di; }
64 NotificationQueue& queueResult() const { return m_queueResult; }
67 NotificationQueue& m_queueResult;
70 class WorkCompletedNotification: public Poco::Notification
73 explicit WorkCompletedNotification(DIFFITEM& di): m_di(di) {}
74 DIFFITEM& data() const { return m_di; }
79 class DiffWorker: public Runnable
82 DiffWorker(NotificationQueue& queue, CDiffContext *pCtxt, int id):
83 m_queue(queue), m_pCtxt(pCtxt), m_id(id) {}
87 FolderCmp fc(m_pCtxt);
88 // keep the scripts alive during the Rescan
89 // when we exit the thread, we delete this and release the scripts
90 CAssureScriptsForThread scriptsForRescan;
92 AutoPtr<Notification> pNf(m_queue.waitDequeueNotification());
93 while (pNf.get() != nullptr)
95 WorkNotification* pWorkNf = dynamic_cast<WorkNotification*>(pNf.get());
96 if (pWorkNf != nullptr) {
97 m_pCtxt->m_pCompareStats->BeginCompare(&pWorkNf->data(), m_id);
98 if (!m_pCtxt->ShouldAbort())
99 CompareDiffItem(fc, pWorkNf->data());
100 pWorkNf->queueResult().enqueueNotification(new WorkCompletedNotification(pWorkNf->data()));
102 pNf = m_queue.waitDequeueNotification();
107 NotificationQueue& m_queue;
108 CDiffContext *m_pCtxt;
112 typedef std::shared_ptr<DiffWorker> DiffWorkerPtr;
115 * @brief Collect file- and folder-names to list.
116 * This function walks given folders and adds found subfolders and files into
117 * lists. There are two modes, determined by the @p depth:
118 * - in non-recursive mode we walk only given folders, and add files
119 * contained. Subfolders are added as folder items, not walked into.
120 * - in recursive mode we walk all subfolders and add the files they
123 * Items are tested against file filters in this function.
125 * @param [in] paths Root paths of compare
126 * @param [in] leftsubdir Left side subdirectory under root path
127 * @param [in] bLeftUniq Is left-side folder unique folder?
128 * @param [in] rightsubdir Right side subdirectory under root path
129 * @param [in] bRightUniq Is right-side folder unique folder?
130 * @param [in] myStruct Compare-related data, like context etc.
131 * @param [in] casesensitive Is filename compare case sensitive?
132 * @param [in] depth Levels of subdirectories to scan, -1 scans all
133 * @param [in] parent Folder diff item to be scanned
134 * @param [in] bUniques If true, walk into unique folders.
135 * @return 1 normally, -1 if compare was aborted
137 int DirScan_GetItems(const PathContext &paths, const String subdir[],
138 DiffFuncStruct *myStruct,
139 bool casesensitive, int depth, DIFFITEM *parent,
142 static const TCHAR backslash[] = _T("\\");
143 int nDirs = paths.GetSize();
144 CDiffContext *pCtxt = myStruct->context;
148 std::copy(paths.begin(), paths.end(), sDir);
150 if (!subdir[0].empty())
152 for (int nIndex = 0; nIndex < paths.GetSize(); nIndex++)
154 sDir[nIndex] = paths::ConcatPath(sDir[nIndex], subdir[nIndex]);
155 subprefix[nIndex] = subdir[nIndex] + backslash;
159 DirItemArray dirs[3], aFiles[3];
160 for (int nIndex = 0; nIndex < nDirs; nIndex++)
161 LoadAndSortFiles(sDir[nIndex], &dirs[nIndex], &aFiles[nIndex], casesensitive);
163 // Allow user to abort scanning
164 if (pCtxt->ShouldAbort())
167 // Handle directories
168 // i points to current directory in left list (leftDirs)
169 // j points to current directory in right list (rightDirs)
173 for (nIndex = 0; nIndex < nDirs; nIndex++)
174 if (dirs[nIndex].size() != 0 || aFiles[nIndex].size() != 0) break;
179 DirItemArray::size_type i=0, j=0, k=0;
182 if (pCtxt->ShouldAbort())
185 if (i >= dirs[0].size() && j >= dirs[1].size() && (nDirs < 3 || k >= dirs[2].size()))
188 unsigned nDiffCode = DIFFCODE::DIR;
189 // Comparing directories leftDirs[i].name to rightDirs[j].name
190 if (i<dirs[0].size() && (j==dirs[1].size() || collstr(dirs[0][i].filename, dirs[1][j].filename, casesensitive)<0)
191 && (nDirs < 3 || (k==dirs[2].size() || collstr(dirs[0][i].filename, dirs[2][k].filename, casesensitive)<0) ))
193 nDiffCode |= DIFFCODE::FIRST;
195 else if (j<dirs[1].size() && (i==dirs[0].size() || collstr(dirs[1][j].filename, dirs[0][i].filename, casesensitive)<0)
196 && (nDirs < 3 || (k==dirs[2].size() || collstr(dirs[1][j].filename, dirs[2][k].filename, casesensitive)<0) ))
198 nDiffCode |= DIFFCODE::SECOND;
202 nDiffCode |= DIFFCODE::BOTH;
206 if (k<dirs[2].size() && (i==dirs[0].size() || collstr(dirs[2][k].filename, dirs[0][i].filename, casesensitive)<0)
207 && (j==dirs[1].size() || collstr(dirs[2][k].filename, dirs[1][j].filename, casesensitive)<0) )
209 nDiffCode |= DIFFCODE::THIRD;
211 else if ((i<dirs[0].size() && j<dirs[1].size() && collstr(dirs[0][i].filename, dirs[1][j].filename, casesensitive) == 0)
212 && (k==dirs[2].size() || collstr(dirs[2][k].filename, dirs[0][i].filename, casesensitive) != 0))
214 nDiffCode |= DIFFCODE::FIRST | DIFFCODE::SECOND;
216 else if ((i<dirs[0].size() && k<dirs[2].size() && collstr(dirs[0][i].filename, dirs[2][k].filename, casesensitive) == 0)
217 && (j==dirs[1].size() || collstr(dirs[1][j].filename, dirs[2][k].filename, casesensitive) != 0))
219 nDiffCode |= DIFFCODE::FIRST | DIFFCODE::THIRD;
221 else if ((j<dirs[1].size() && k<dirs[2].size() && collstr(dirs[1][j].filename, dirs[2][k].filename, casesensitive) == 0)
222 && (i==dirs[0].size() || collstr(dirs[0][i].filename, dirs[1][j].filename, casesensitive) != 0))
224 nDiffCode |= DIFFCODE::SECOND | DIFFCODE::THIRD;
228 nDiffCode |= DIFFCODE::ALL;
237 leftnewsub = (nDiffCode & DIFFCODE::FIRST) ? subprefix[0] + dirs[0][i].filename.get() : subprefix[0] + dirs[1][j].filename.get();
238 rightnewsub = (nDiffCode & DIFFCODE::SECOND) ? subprefix[1] + dirs[1][j].filename.get() : subprefix[1] + dirs[0][i].filename.get();
240 // Test against filter so we don't include contents of filtered out directories
241 // Also this is only place we can test for both-sides directories in recursive compare
242 if ((pCtxt->m_piFilterGlobal!=nullptr && !pCtxt->m_piFilterGlobal->includeDir(leftnewsub, rightnewsub)) ||
243 (pCtxt->m_bIgnoreReparsePoints && (
244 (nDiffCode & DIFFCODE::FIRST) && (dirs[0][i].flags.attributes & FILE_ATTRIBUTE_REPARSE_POINT) ||
245 (nDiffCode & DIFFCODE::SECOND) && (dirs[1][j].flags.attributes & FILE_ATTRIBUTE_REPARSE_POINT))
248 nDiffCode |= DIFFCODE::SKIPPED;
252 leftnewsub = subprefix[0];
253 if (nDiffCode & DIFFCODE::FIRST) leftnewsub += dirs[0][i].filename;
254 else if (nDiffCode & DIFFCODE::SECOND) leftnewsub += dirs[1][j].filename;
255 else if (nDiffCode & DIFFCODE::THIRD) leftnewsub += dirs[2][k].filename;
256 middlenewsub = subprefix[1];
257 if (nDiffCode & DIFFCODE::SECOND) middlenewsub += dirs[1][j].filename;
258 else if (nDiffCode & DIFFCODE::FIRST) middlenewsub += dirs[0][i].filename;
259 else if (nDiffCode & DIFFCODE::THIRD) middlenewsub += dirs[2][k].filename;
260 rightnewsub = subprefix[2];
261 if (nDiffCode & DIFFCODE::THIRD) rightnewsub += dirs[2][k].filename;
262 else if (nDiffCode & DIFFCODE::FIRST) rightnewsub += dirs[0][i].filename;
263 else if (nDiffCode & DIFFCODE::SECOND) rightnewsub += dirs[1][j].filename;
265 // Test against filter so we don't include contents of filtered out directories
266 // Also this is only place we can test for both-sides directories in recursive compare
267 if ((pCtxt->m_piFilterGlobal!=nullptr && !pCtxt->m_piFilterGlobal->includeDir(leftnewsub, middlenewsub, rightnewsub)) ||
268 (pCtxt->m_bIgnoreReparsePoints && (
269 (nDiffCode & DIFFCODE::FIRST) && (dirs[0][i].flags.attributes & FILE_ATTRIBUTE_REPARSE_POINT) ||
270 (nDiffCode & DIFFCODE::SECOND) && (dirs[1][j].flags.attributes & FILE_ATTRIBUTE_REPARSE_POINT) ||
271 (nDiffCode & DIFFCODE::THIRD) && (dirs[2][k].flags.attributes & FILE_ATTRIBUTE_REPARSE_POINT))
274 nDiffCode |= DIFFCODE::SKIPPED;
281 AddToList(subdir[0], subdir[1],
282 (nDiffCode & DIFFCODE::FIRST ) ? &dirs[0][i] : nullptr,
283 (nDiffCode & DIFFCODE::SECOND) ? &dirs[1][j] : nullptr,
284 nDiffCode, myStruct, parent);
286 AddToList(subdir[0], subdir[1], subdir[2],
287 (nDiffCode & DIFFCODE::FIRST ) ? &dirs[0][i] : nullptr,
288 (nDiffCode & DIFFCODE::SECOND) ? &dirs[1][j] : nullptr,
289 (nDiffCode & DIFFCODE::THIRD ) ? &dirs[2][k] : nullptr,
290 nDiffCode, myStruct, parent);
295 assert(pCtxt->m_bRecursive);
298 DIFFITEM *me = AddToList(subdir[0], subdir[1],
299 (nDiffCode & DIFFCODE::FIRST ) ? &dirs[0][i] : nullptr,
300 (nDiffCode & DIFFCODE::SECOND) ? &dirs[1][j] : nullptr,
301 nDiffCode, myStruct, parent);
302 if ((nDiffCode & DIFFCODE::SKIPPED) == 0 && ((nDiffCode & DIFFCODE::SIDEFLAGS) == DIFFCODE::BOTH || bUniques))
304 // Scan recursively all subdirectories too, we are not adding folders
305 String newsubdir[3] = {leftnewsub, rightnewsub};
306 int result = DirScan_GetItems(paths, newsubdir, myStruct, casesensitive,
307 depth - 1, me, bUniques);
314 DIFFITEM *me = AddToList(subdir[0], subdir[1], subdir[2],
315 (nDiffCode & DIFFCODE::FIRST ) ? &dirs[0][i] : nullptr,
316 (nDiffCode & DIFFCODE::SECOND) ? &dirs[1][j] : nullptr,
317 (nDiffCode & DIFFCODE::THIRD ) ? &dirs[2][k] : nullptr,
318 nDiffCode, myStruct, parent);
319 if ((nDiffCode & DIFFCODE::SKIPPED) == 0 && ((nDiffCode & DIFFCODE::SIDEFLAGS) == DIFFCODE::ALL || bUniques))
321 // Scan recursively all subdirectories too, we are not adding folders
322 String newsubdir[3] = {leftnewsub, middlenewsub, rightnewsub};
323 int result = DirScan_GetItems(paths, newsubdir, myStruct, casesensitive,
324 depth - 1, me, bUniques);
330 if (nDiffCode & DIFFCODE::FIRST)
332 if (nDiffCode & DIFFCODE::SECOND)
334 if (nDiffCode & DIFFCODE::THIRD)
338 // i points to current file in left list (aFiles[0])
339 // j points to current file in right list (aFiles[1])
343 if (pCtxt->ShouldAbort())
347 // Comparing file aFiles[0][i].name to aFiles[1][j].name
348 if (i<aFiles[0].size() && (j==aFiles[1].size() ||
349 collstr(aFiles[0][i].filename, aFiles[1][j].filename, casesensitive) < 0)
351 (k==aFiles[2].size() || collstr(aFiles[0][i].filename, aFiles[2][k].filename, casesensitive)<0) ))
355 const unsigned nDiffCode = DIFFCODE::FIRST | DIFFCODE::FILE;
356 AddToList(subdir[0], subdir[1], &aFiles[0][i], nullptr, nDiffCode, myStruct, parent);
360 const unsigned nDiffCode = DIFFCODE::FIRST | DIFFCODE::FILE;
361 AddToList(subdir[0], subdir[1], subdir[2], &aFiles[0][i], nullptr, nullptr, nDiffCode, myStruct, parent);
363 // Advance left pointer over left-only entry, and then retest with new pointers
367 if (j<aFiles[1].size() && (i==aFiles[0].size() ||
368 collstr(aFiles[0][i].filename, aFiles[1][j].filename, casesensitive) > 0)
370 (k==aFiles[2].size() || collstr(aFiles[1][j].filename, aFiles[2][k].filename, casesensitive)<0) ))
372 const unsigned nDiffCode = DIFFCODE::SECOND | DIFFCODE::FILE;
374 AddToList(subdir[0], subdir[1], nullptr, &aFiles[1][j], nDiffCode, myStruct, parent);
376 AddToList(subdir[0], subdir[1], subdir[2], nullptr, &aFiles[1][j], nullptr, nDiffCode, myStruct, parent);
377 // Advance right pointer over right-only entry, and then retest with new pointers
383 if (k<aFiles[2].size() && (i==aFiles[0].size() ||
384 collstr(aFiles[2][k].filename, aFiles[0][i].filename, casesensitive)<0)
385 && (j==aFiles[1].size() || collstr(aFiles[2][k].filename, aFiles[1][j].filename, casesensitive)<0) )
387 const unsigned nDiffCode = DIFFCODE::THIRD | DIFFCODE::FILE;
388 AddToList(subdir[0], subdir[1], subdir[2], nullptr, nullptr, &aFiles[2][k], nDiffCode, myStruct, parent);
390 // Advance right pointer over right-only entry, and then retest with new pointers
394 if ((i<aFiles[0].size() && j<aFiles[1].size() && collstr(aFiles[0][i].filename, aFiles[1][j].filename, casesensitive) == 0)
395 && (k==aFiles[2].size() || collstr(aFiles[0][i].filename, aFiles[2][k].filename, casesensitive) != 0))
397 const unsigned nDiffCode = DIFFCODE::FIRST | DIFFCODE::SECOND | DIFFCODE::FILE;
398 AddToList(subdir[0], subdir[1], subdir[2], &aFiles[0][i], &aFiles[1][j], nullptr, nDiffCode, myStruct, parent);
403 else if ((i<aFiles[0].size() && k<aFiles[2].size() && collstr(aFiles[0][i].filename, aFiles[2][k].filename, casesensitive) == 0)
404 && (j==aFiles[1].size() || collstr(aFiles[1][j].filename, aFiles[2][k].filename, casesensitive) != 0))
406 const unsigned nDiffCode = DIFFCODE::FIRST | DIFFCODE::THIRD | DIFFCODE::FILE;
407 AddToList(subdir[0], subdir[1], subdir[2], &aFiles[0][i], nullptr, &aFiles[2][k], nDiffCode, myStruct, parent);
412 else if ((j<aFiles[1].size() && k<aFiles[2].size() && collstr(aFiles[1][j].filename, aFiles[2][k].filename, casesensitive) == 0)
413 && (i==aFiles[0].size() || collstr(aFiles[0][i].filename, aFiles[1][j].filename, casesensitive) != 0))
415 const unsigned nDiffCode = DIFFCODE::SECOND | DIFFCODE::THIRD | DIFFCODE::FILE;
416 AddToList(subdir[0], subdir[1], subdir[2], nullptr, &aFiles[1][j], &aFiles[2][k], nDiffCode, myStruct, parent);
422 if (i<aFiles[0].size())
426 assert(j<aFiles[1].size());
427 const unsigned nDiffCode = DIFFCODE::BOTH | DIFFCODE::FILE;
428 AddToList(subdir[0], subdir[1], &aFiles[0][i], &aFiles[1][j], nDiffCode, myStruct, parent);
435 assert(j<aFiles[1].size());
436 assert(k<aFiles[2].size());
437 const unsigned nDiffCode = DIFFCODE::ALL | DIFFCODE::FILE;
438 AddToList(subdir[0], subdir[1], subdir[2], &aFiles[0][i], &aFiles[1][j], &aFiles[2][k], nDiffCode, myStruct, parent);
448 if (parent != nullptr)
450 for (int nIndex = 0; nIndex < nDirs; ++nIndex)
451 if (parent->diffcode.exists(nIndex) && parent->diffFileInfo[nIndex].size == DirItem::FILE_SIZE_NONE)
452 parent->diffFileInfo[nIndex].size = 0;
454 DIFFITEM *dic = parent->GetFirstChild();
457 for (int nIndex = 0; nIndex < nDirs; ++nIndex)
459 if (dic->diffFileInfo[nIndex].size != DirItem::FILE_SIZE_NONE)
460 parent->diffFileInfo[nIndex].size += dic->diffFileInfo[nIndex].size;
462 dic = dic->GetFwdSiblingLink();
470 * @brief Compare DiffItems in list and add results to compare context.
472 * @param myStruct [in] A structure containing compare-related data.
473 * @param parentdiffpos [in] Position of parent diff item
474 * @return >= 0 number of diff items, -1 if compare was aborted
476 int DirScan_CompareItems(DiffFuncStruct *myStruct, DIFFITEM *parentdiffpos)
478 const int compareMethod = myStruct->context->GetCompareMethod();
481 if (compareMethod == CMP_CONTENT || compareMethod == CMP_QUICK_CONTENT)
483 nworkers = GetOptionsMgr()->GetInt(OPT_CMP_COMPARE_THREADS);
485 nworkers += Environment::processorCount();
486 nworkers = std::clamp(nworkers, 1, static_cast<int>(Environment::processorCount()));
489 ThreadPool threadPool(nworkers, nworkers);
490 std::vector<DiffWorkerPtr> workers;
491 NotificationQueue queue;
492 myStruct->context->m_pCompareStats->SetCompareThreadCount(nworkers);
493 for (int i = 0; i < nworkers; ++i)
495 workers.emplace_back(std::make_shared<DiffWorker>(queue, myStruct->context, i));
496 threadPool.start(*workers[i]);
499 int res = CompareItems(queue, myStruct, parentdiffpos);
503 threadPool.joinAll();
508 static int CompareItems(NotificationQueue& queue, DiffFuncStruct *myStruct, DIFFITEM *parentdiffpos)
510 NotificationQueue queueResult;
512 CDiffContext *pCtxt = myStruct->context;
515 bool bCompareFailure = false;
516 if (parentdiffpos == nullptr)
517 myStruct->pSemaphore->wait();
519 int nDirs = pCtxt->GetCompareDirs();
520 DIFFITEM *pos = pCtxt->GetFirstChildDiffPosition(parentdiffpos);
521 while (pos != nullptr)
523 if (pCtxt->ShouldAbort())
526 if (stopwatch.elapsed() > 2000000)
528 int event = CDiffThread::EVENT_COMPARE_PROGRESSED;
529 myStruct->m_listeners.notify(myStruct, event);
532 myStruct->pSemaphore->wait();
533 DIFFITEM *curpos = pos;
534 DIFFITEM &di = pCtxt->GetNextSiblingDiffRefPosition(pos);
535 bool existsalldirs = di.diffcode.existAll();
536 if (di.diffcode.isDirectory() && pCtxt->m_bRecursive)
538 if ((di.diffcode.diffcode & DIFFCODE::CMPERR) != DIFFCODE::CMPERR)
539 { // Only clear DIFF|SAME flags if not CMPERR (eg. both flags together)
540 di.diffcode.diffcode &= ~(DIFFCODE::DIFF | DIFFCODE::SAME);
542 int ndiff = CompareItems(queue, myStruct, curpos);
543 // Propagate sub-directory status to this directory
545 { // There were differences in the sub-directories
546 if (existsalldirs || pCtxt->m_bWalkUniques)
547 di.diffcode.diffcode |= DIFFCODE::DIFF;
552 { // Sub-directories were identical
554 di.diffcode.diffcode |= DIFFCODE::SAME;
555 else if (pCtxt->m_bWalkUniques && !di.diffcode.isResultFiltered())
556 di.diffcode.diffcode |= DIFFCODE::DIFF;
560 { // There were file IO-errors during sub-directory comparison.
561 di.diffcode.diffcode |= DIFFCODE::CMPERR;
562 bCompareFailure = true;
565 if (nDirs == 3 && (di.diffcode.diffcode & DIFFCODE::COMPAREFLAGS) == DIFFCODE::DIFF && !di.diffcode.isResultFiltered())
567 di.diffcode.diffcode &= ~DIFFCODE::COMPAREFLAGS3WAY;
568 di.diffcode.diffcode |= GetDirCompareFlags3Way(di);
572 queue.enqueueUrgentNotification(new WorkNotification(di, queueResult));
574 queue.enqueueNotification(new WorkNotification(di, queueResult));
577 pCtxt->GetNextSiblingDiffRefPosition(pos);
582 AutoPtr<Notification> pNf(queueResult.waitDequeueNotification());
583 if (pNf.get() == nullptr)
585 WorkCompletedNotification* pWorkCompletedNf = dynamic_cast<WorkCompletedNotification*>(pNf.get());
586 if (pWorkCompletedNf != nullptr) {
587 DIFFITEM &di = pWorkCompletedNf->data();
588 if (di.diffcode.isResultError()) {
589 DIFFITEM *diParent = di.GetParentLink();
590 assert(diParent != nullptr);
591 if (diParent != nullptr)
593 diParent->diffcode.diffcode |= DIFFCODE::CMPERR;
594 bCompareFailure = true;
598 if (di.diffcode.isResultDiff() ||
599 (!di.diffcode.existAll() && !di.diffcode.isResultFiltered()))
605 return bCompareFailure || pCtxt->ShouldAbort() ? -1 : res;
609 * @brief Compare DiffItems in context marked for rescan.
611 * @param myStruct [in,out] A structure containing compare-related data.
612 * @param parentdiffpos [in] Position of parent diff item
613 * @return >= 0 number of diff items, -1 if compare was aborted
615 static int CompareRequestedItems(DiffFuncStruct *myStruct, DIFFITEM *parentdiffpos)
617 CDiffContext *pCtxt = myStruct->context;
620 bool bCompareFailure = false;
621 bool bCompareIndeterminate = false;
622 if (parentdiffpos == nullptr)
623 myStruct->pSemaphore->wait();
625 // Since the collect thread deletes the DiffItems in the rescan by "Refresh selected",
626 // the compare thread process should not be executed until the collect thread process is completed
627 // to avoid accessing the deleted DiffItems.
628 assert(myStruct->nCollectThreadState == CDiffThread::THREAD_COMPLETED);
630 int nDirs = pCtxt->GetCompareDirs();
631 DIFFITEM *pos = pCtxt->GetFirstChildDiffPosition(parentdiffpos);
632 while (pos != nullptr)
634 if (pCtxt->ShouldAbort())
640 DIFFITEM *curpos = pos;
641 DIFFITEM &di = pCtxt->GetNextSiblingDiffRefPosition(pos);
642 bool existsalldirs = di.diffcode.existAll();
643 if (di.diffcode.isDirectory())
645 if (pCtxt->m_bRecursive)
647 di.diffcode.diffcode &= ~(DIFFCODE::DIFF | DIFFCODE::SAME);
648 int ndiff = CompareRequestedItems(myStruct, curpos);
651 if (existsalldirs || pCtxt->m_bWalkUniques)
652 di.diffcode.diffcode |= DIFFCODE::DIFF;
659 di.diffcode.diffcode |= DIFFCODE::SAME;
660 else if (pCtxt->m_bWalkUniques && !di.diffcode.isResultFiltered())
661 di.diffcode.diffcode |= DIFFCODE::DIFF;
665 { // There were file IO-errors during sub-directory comparison.
666 di.diffcode.diffcode |= DIFFCODE::CMPERR;
667 bCompareFailure = true;
671 { // There were files that have not been compared
672 bCompareIndeterminate = true;
675 if (nDirs == 3 && (di.diffcode.diffcode & DIFFCODE::COMPAREFLAGS) == DIFFCODE::DIFF && !di.diffcode.isResultFiltered())
677 di.diffcode.diffcode &= ~DIFFCODE::COMPAREFLAGS3WAY;
678 di.diffcode.diffcode |= GetDirCompareFlags3Way(di);
684 if (di.diffcode.isScanNeeded())
686 CompareDiffItem(fc, di);
687 if (di.diffcode.isResultError())
689 DIFFITEM *diParent = di.GetParentLink();
690 assert(diParent != nullptr);
691 if (diParent != nullptr)
693 diParent->diffcode.diffcode |= DIFFCODE::CMPERR;
694 bCompareFailure = true;
700 if (di.diffcode.isResultError())
701 bCompareFailure = true;
702 else if (di.diffcode.isResultNone() || di.diffcode.isResultAbort())
703 bCompareIndeterminate = true;
706 if (di.diffcode.isResultDiff() ||
707 (!existsalldirs && !di.diffcode.isResultFiltered()))
710 return bCompareIndeterminate ? -2 : (bCompareFailure ? -1 : res);
713 int DirScan_CompareRequestedItems(DiffFuncStruct *myStruct, DIFFITEM *parentdiffpos)
715 return CompareRequestedItems(myStruct, parentdiffpos);
718 static int markChildrenForRescan(CDiffContext *pCtxt, DIFFITEM *parentdiffpos)
721 DIFFITEM *pos = pCtxt->GetFirstChildDiffPosition(parentdiffpos);
722 while (pos != nullptr)
724 DIFFITEM *curpos = pos;
725 DIFFITEM &di = pCtxt->GetNextSiblingDiffRefPosition(pos);
726 if (di.diffcode.isDirectory())
727 ncount += markChildrenForRescan(pCtxt, curpos);
730 di.diffcode.diffcode |= DIFFCODE::NEEDSCAN;
737 int DirScan_UpdateMarkedItems(DiffFuncStruct *myStruct, DIFFITEM *parentdiffpos)
739 CDiffContext *pCtxt = myStruct->context;
740 DIFFITEM *pos = pCtxt->GetFirstChildDiffPosition(parentdiffpos);
743 while (pos != nullptr)
745 if (pCtxt->ShouldAbort())
747 DIFFITEM *curpos = pos;
748 DIFFITEM &di = pCtxt->GetNextSiblingDiffRefPosition(pos);
749 if (di.diffcode.isScanNeeded())
751 bool bItemsExist = true;
752 UpdateDiffItem(di, bItemsExist, pCtxt);
755 di.DelinkFromSiblings(); // delink from list of Siblings
756 delete &di; // Also delete all Children items
757 continue; // (... because `di` is now invalid)
759 if (!di.diffcode.isDirectory())
762 if (di.diffcode.isDirectory() && pCtxt->m_bRecursive)
764 for (int i = 0; i < pCtxt->GetCompareDirs(); ++i)
765 if (di.diffcode.exists(i))
766 di.diffFileInfo[i].size = 0;
767 if (di.diffcode.isScanNeeded() && !di.diffcode.isResultFiltered())
770 di.diffcode.diffcode &= ~DIFFCODE::NEEDSCAN;
772 bool casesensitive = false;
773 int depth = myStruct->context->m_bRecursive ? -1 : 0;
775 PathContext paths = myStruct->context->GetNormalizedPaths();
776 for (int i = 0; i < pCtxt->GetCompareDirs(); ++i)
777 subdir[i] = di.diffFileInfo[i].GetFile();
778 DirScan_GetItems(paths, subdir, myStruct,
779 casesensitive, depth, &di, myStruct->context->m_bWalkUniques);
780 ncount += markChildrenForRescan(myStruct->context, curpos);
784 ncount += DirScan_UpdateMarkedItems(myStruct, curpos);
787 if (parentdiffpos != nullptr && pCtxt->m_bRecursive)
789 for (int nIndex = 0; nIndex < pCtxt->GetCompareDirs(); ++nIndex)
790 if (curpos->diffFileInfo[nIndex].size != DirItem::FILE_SIZE_NONE)
791 parentdiffpos->diffFileInfo[nIndex].size += curpos->diffFileInfo[nIndex].size;
797 * @brief Update diffitem file/dir infos.
799 * Re-tests dirs/files if sides still exists, and updates infos for
800 * existing sides. This assumes filenames, or paths are not changed.
801 * Since in normal situations (I can think of) they cannot change
802 * after first compare.
804 * @param [in,out] di DiffItem to update.
805 * @param [out] bExists Set to
806 * - true if one of items exists so diffitem is valid
807 * - false if items were deleted, so diffitem is not valid
808 * @param [in] pCtxt Compare context
810 static void UpdateDiffItem(DIFFITEM &di, bool & bExists, CDiffContext *pCtxt)
813 di.diffcode.setSideNone();
814 for (int i = 0; i < pCtxt->GetCompareDirs(); ++i)
816 di.diffFileInfo[i].ClearPartial();
817 if (pCtxt->UpdateInfoFromDiskHalf(di, i))
819 bool bUpdated = false;
820 if (di.diffFileInfo[i].IsDirectory() == di.diffcode.isDirectory())
822 String filepath = paths::ConcatPath(pCtxt->GetPath(i), di.diffFileInfo[i].GetFile());
823 if (di.diffFileInfo[i].UpdateFileName(filepath)) {
824 di.diffcode.diffcode |= DIFFCODE::FIRST << i;
830 di.diffFileInfo[i].ClearPartial();
836 * @brief Compare two diffitems and add results to difflist in context.
838 * This function does the actual compare for previously gathered list of
839 * items. Basically we:
840 * - ignore items matching file filters
841 * - add non-ignored directories (no compare for directory items)
845 * @param [in] di DiffItem to compare
846 * @param [in,out] pCtxt Compare context: contains difflist, encoding info etc.
847 * @todo For date compare, maybe we should use creation date if modification
850 static void CompareDiffItem(FolderCmp &fc, DIFFITEM &di)
852 CDiffContext *const pCtxt = fc.m_pCtxt;
853 int nDirs = pCtxt->GetCompareDirs();
854 // Clear rescan-request flag (not set by all codepaths)
855 di.diffcode.diffcode &= ~DIFFCODE::NEEDSCAN;
856 // Is it a directory?
857 if (di.diffcode.isDirectory())
859 // We don't actually 'compare' directories, just add non-ignored
860 // directories to list.
864 // 1. Test against filters
865 if (pCtxt->m_piFilterGlobal==nullptr ||
866 (nDirs == 2 && pCtxt->m_piFilterGlobal->includeFile(
867 paths::ConcatPath(di.diffFileInfo[0].path, di.diffFileInfo[0].filename),
868 paths::ConcatPath(di.diffFileInfo[1].path, di.diffFileInfo[1].filename)
870 (nDirs == 3 && pCtxt->m_piFilterGlobal->includeFile(
871 paths::ConcatPath(di.diffFileInfo[0].path, di.diffFileInfo[0].filename),
872 paths::ConcatPath(di.diffFileInfo[1].path, di.diffFileInfo[1].filename),
873 paths::ConcatPath(di.diffFileInfo[2].path, di.diffFileInfo[2].filename)
876 di.diffcode.diffcode |= DIFFCODE::INCLUDED;
877 di.diffcode.diffcode |= fc.prepAndCompareFiles(di);
878 di.nsdiffs = fc.m_ndiffs;
879 di.nidiffs = fc.m_ntrivialdiffs;
881 for (int i = 0; i < nDirs; ++i)
883 // Set text statistics
884 if (di.diffcode.exists(i))
886 di.diffFileInfo[i].m_textStats = fc.m_diffFileData.m_textStats[i];
887 di.diffFileInfo[i].encoding = fc.m_diffFileData.m_FileLocation[i].encoding;
893 di.diffcode.diffcode |= DIFFCODE::SKIPPED;
896 pCtxt->m_pCompareStats->AddItem(di.diffcode.diffcode);
900 * @brief Add one compare item to list.
901 * @param [in] sLeftDir Left subdirectory.
902 * @param [in] sRightDir Right subdirectory.
903 * @param [in] lent Left item data to add.
904 * @param [in] rent Right item data to add.
905 * @param [in] pCtxt Compare context.
906 * @param [in] parent Parent of item to be added
908 static DIFFITEM *AddToList(const String& sLeftDir, const String& sRightDir,
909 const DirItem * lent, const DirItem * rent,
910 unsigned code, DiffFuncStruct *myStruct, DIFFITEM *parent)
912 return AddToList(sLeftDir, sRightDir, sLeftDir, lent, rent, nullptr, code, myStruct, parent, 2);
916 * @brief Add one compare item to list.
918 static DIFFITEM *AddToList(const String& sDir1, const String& sDir2, const String& sDir3,
919 const DirItem *ent1, const DirItem *ent2, const DirItem *ent3,
920 unsigned code, DiffFuncStruct *myStruct, DIFFITEM *parent, int nItems /*= 3*/)
922 // We must store both paths - we cannot get paths later
923 // and we need unique item paths for example when items
924 // change to identical
925 DIFFITEM *di = myStruct->context->AddNewDiff(parent);
927 di->diffFileInfo[0].path = sDir1;
928 di->diffFileInfo[1].path = sDir2;
929 di->diffFileInfo[2].path = sDir3;
933 di->diffFileInfo[0].filename = ent1->filename;
934 di->diffFileInfo[0].mtime = ent1->mtime;
935 di->diffFileInfo[0].ctime = ent1->ctime;
936 di->diffFileInfo[0].size = ent1->size;
937 di->diffFileInfo[0].flags.attributes = ent1->flags.attributes;
941 // Don't break CDirView::DoCopyRightToLeft()
943 di->diffFileInfo[0].filename = ent3->filename;
944 else if (ent2 != nullptr)
945 di->diffFileInfo[0].filename = ent2->filename;
950 di->diffFileInfo[1].filename = ent2->filename;
951 di->diffFileInfo[1].mtime = ent2->mtime;
952 di->diffFileInfo[1].ctime = ent2->ctime;
953 di->diffFileInfo[1].size = ent2->size;
954 di->diffFileInfo[1].flags.attributes = ent2->flags.attributes;
958 // Don't break CDirView::DoCopyLeftToRight()
960 di->diffFileInfo[1].filename = ent1->filename;
961 else if (ent3 != nullptr)
962 di->diffFileInfo[1].filename = ent3->filename;
967 di->diffFileInfo[2].filename = ent3->filename;
968 di->diffFileInfo[2].mtime = ent3->mtime;
969 di->diffFileInfo[2].ctime = ent3->ctime;
970 di->diffFileInfo[2].size = ent3->size;
971 di->diffFileInfo[2].flags.attributes = ent3->flags.attributes;
975 // Don't break CDirView::DoCopyLeftToRight()
977 di->diffFileInfo[2].filename = ent1->filename;
978 else if (ent2 != nullptr)
979 di->diffFileInfo[2].filename = ent2->filename;
983 di->diffcode.diffcode = code;
985 di->diffcode.diffcode = code | DIFFCODE::THREEWAY;
987 if (!myStruct->bMarkedRescan && myStruct->m_fncCollect)
989 myStruct->context->m_pCompareStats->IncreaseTotalItems();
990 myStruct->pSemaphore->set();
996 * @brief Get the 3-way compare flag of the specified directory item.
997 * @param [in] di Directory Item to get the 3-way compare flag.
998 * @return 3-way compare flag of the specified directory item.
1000 static unsigned GetDirCompareFlags3Way(const DIFFITEM& di)
1002 assert(di.diffcode.isDirectory());
1003 assert((di.diffcode.diffcode & DIFFCODE::COMPAREFLAGS) == DIFFCODE::DIFF && !di.diffcode.isResultFiltered());
1006 unsigned code = DIFFCODE::DIFFALL;
1008 if (di.diffcode.isSideFirstOnly() || di.diffcode.isMissingFirstOnly())
1010 code = DIFFCODE::DIFF1STONLY;
1013 else if (di.diffcode.isSideSecondOnly() || di.diffcode.isMissingSecondOnly())
1015 code = DIFFCODE::DIFF2NDONLY;
1018 else if (di.diffcode.isSideThirdOnly() || di.diffcode.isMissingThirdOnly())
1020 code = DIFFCODE::DIFF3RDONLY;
1024 if (di.HasChildren())
1026 for (DIFFITEM* pdi = di.GetFirstChild(); pdi != nullptr; pdi = pdi->GetFwdSiblingLink())
1028 if ((pdi->diffcode.diffcode & DIFFCODE::COMPAREFLAGS) == DIFFCODE::DIFF && !pdi->diffcode.isResultFiltered())
1032 code = (pdi->diffcode.diffcode & DIFFCODE::COMPAREFLAGS3WAY);
1039 case DIFFCODE::DIFF1STONLY:
1040 if ((pdi->diffcode.diffcode & DIFFCODE::COMPAREFLAGS3WAY) != DIFFCODE::DIFF1STONLY)
1041 code = DIFFCODE::DIFFALL;
1043 case DIFFCODE::DIFF2NDONLY:
1044 if ((pdi->diffcode.diffcode & DIFFCODE::COMPAREFLAGS3WAY) != DIFFCODE::DIFF2NDONLY)
1045 code = DIFFCODE::DIFFALL;
1047 case DIFFCODE::DIFF3RDONLY:
1048 if ((pdi->diffcode.diffcode & DIFFCODE::COMPAREFLAGS3WAY) != DIFFCODE::DIFF3RDONLY)
1049 code = DIFFCODE::DIFFALL;
1052 code = DIFFCODE::DIFFALL;