1 // -----------------------------------------------------------------------
2 // <copyright file="NetworkAgent.cs" company="GRNET">
3 // Copyright 2011-2012 GRNET S.A. All rights reserved.
5 // Redistribution and use in source and binary forms, with or
6 // without modification, are permitted provided that the following
9 // 1. Redistributions of source code must retain the above
10 // copyright notice, this list of conditions and the following
13 // 2. Redistributions in binary form must reproduce the above
14 // copyright notice, this list of conditions and the following
15 // disclaimer in the documentation and/or other materials
16 // provided with the distribution.
18 // THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
19 // OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
22 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
25 // USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26 // AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 // LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
28 // ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 // POSSIBILITY OF SUCH DAMAGE.
31 // The views and conclusions contained in the software and
32 // documentation are those of the authors and should not be
33 // interpreted as representing official policies, either expressed
34 // or implied, of GRNET S.A.
36 // -----------------------------------------------------------------------
39 using System.Collections.Concurrent;
40 using System.Collections.Generic;
41 using System.ComponentModel.Composition;
42 using System.Diagnostics;
43 using System.Diagnostics.Contracts;
47 using System.Threading;
48 using System.Threading.Tasks;
49 using System.Threading.Tasks.Dataflow;
50 using Castle.ActiveRecord;
51 using Pithos.Interfaces;
55 namespace Pithos.Core.Agents
57 //TODO: Ensure all network operations use exact casing. Pithos is case sensitive
59 public class NetworkAgent
61 private Agent<CloudAction> _agent;
63 //A separate agent is used to execute delete actions immediatelly;
64 private ActionBlock<CloudDeleteAction> _deleteAgent;
65 readonly ConcurrentDictionary<string,DateTime> _deletedFiles=new ConcurrentDictionary<string, DateTime>();
68 private readonly ManualResetEventSlim _pauseAgent = new ManualResetEventSlim(true);
70 [System.ComponentModel.Composition.Import]
71 public IStatusKeeper StatusKeeper { get; set; }
73 public IStatusNotification StatusNotification { get; set; }
75 private static readonly ILog Log = LogManager.GetLogger("NetworkAgent");
77 private readonly ConcurrentBag<AccountInfo> _accounts = new ConcurrentBag<AccountInfo>();
79 [System.ComponentModel.Composition.Import]
80 public IPithosSettings Settings { get; set; }
82 private bool _firstPoll = true;
83 private TaskCompletionSource<bool> _tcs;
84 private ConcurrentDictionary<string,DateTime> _lastSeen=new ConcurrentDictionary<string, DateTime>();
89 _agent = Agent<CloudAction>.Start(inbox =>
95 var message = inbox.Receive();
96 var process=message.Then(Process,inbox.CancellationToken);
97 inbox.LoopAsync(process, loop);
102 _deleteAgent = new ActionBlock<CloudDeleteAction>(message =>ProcessDelete(message),new ExecutionDataflowBlockOptions{MaxDegreeOfParallelism=4});
107 var message = inbox.Receive();
108 var process = message.Then(ProcessDelete,inbox.CancellationToken);
109 inbox.LoopAsync(process, loop);
116 private async Task Process(CloudAction action)
119 throw new ArgumentNullException("action");
120 if (action.AccountInfo==null)
121 throw new ArgumentException("The action.AccountInfo is empty","action");
122 Contract.EndContractBlock();
124 UpdateStatus(PithosStatus.Syncing);
125 var accountInfo = action.AccountInfo;
127 using (log4net.ThreadContext.Stacks["NETWORK"].Push("PROCESS"))
129 Log.InfoFormat("[ACTION] Start Processing {0}", action);
131 var cloudFile = action.CloudFile;
132 var downloadPath = action.GetDownloadPath();
136 if (action.Action == CloudActionType.DeleteCloud)
138 //Redirect deletes to the delete agent
139 _deleteAgent.Post((CloudDeleteAction)action);
141 if (IsDeletedFile(action))
143 //Clear the status of already deleted files to avoid reprocessing
144 if (action.LocalFile != null)
145 this.StatusKeeper.ClearFileStatus(action.LocalFile.FullName);
149 switch (action.Action)
151 case CloudActionType.UploadUnconditional:
152 //Abort if the file was deleted before we reached this point
153 await UploadCloudFile(action);
155 case CloudActionType.DownloadUnconditional:
156 await DownloadCloudFile(accountInfo, cloudFile, downloadPath);
158 case CloudActionType.RenameCloud:
159 var moveAction = (CloudMoveAction)action;
160 RenameCloudFile(accountInfo, moveAction);
162 case CloudActionType.MustSynch:
163 if (!File.Exists(downloadPath) && !Directory.Exists(downloadPath))
165 await DownloadCloudFile(accountInfo, cloudFile, downloadPath);
169 await SyncFiles(accountInfo, action);
174 Log.InfoFormat("[ACTION] End Processing {0}:{1}->{2}", action.Action, action.LocalFile,
175 action.CloudFile.Name);
177 catch (WebException exc)
179 Log.ErrorFormat("[WEB ERROR] {0} : {1} -> {2} due to exception\r\n{3}", action.Action, action.LocalFile, action.CloudFile, exc);
181 catch (OperationCanceledException)
185 catch (DirectoryNotFoundException)
187 Log.ErrorFormat("{0} : {1} -> {2} failed because the directory was not found.\n Rescheduling a delete",
188 action.Action, action.LocalFile, action.CloudFile);
189 //Post a delete action for the missing file
190 Post(new CloudDeleteAction(action));
192 catch (FileNotFoundException)
194 Log.ErrorFormat("{0} : {1} -> {2} failed because the file was not found.\n Rescheduling a delete",
195 action.Action, action.LocalFile, action.CloudFile);
196 //Post a delete action for the missing file
197 Post(new CloudDeleteAction(action));
199 catch (Exception exc)
201 Log.ErrorFormat("[REQUEUE] {0} : {1} -> {2} due to exception\r\n{3}",
202 action.Action, action.LocalFile, action.CloudFile, exc);
208 UpdateStatus(PithosStatus.InSynch);
213 private void UpdateStatus(PithosStatus status)
215 StatusKeeper.SetPithosStatus(status);
216 StatusNotification.Notify(new Notification());
220 /// Processes cloud delete actions
222 /// <param name="action">The delete action to execute</param>
223 /// <returns></returns>
225 /// When a file/folder is deleted locally, we must delete it ASAP from the server and block any download
226 /// operations that may be in progress.
228 /// A separate agent is used to process deletes because the main agent may be busy with a long operation.
231 private async Task ProcessDelete(CloudDeleteAction action)
234 throw new ArgumentNullException("action");
235 if (action.AccountInfo==null)
236 throw new ArgumentException("The action.AccountInfo is empty","action");
237 Contract.EndContractBlock();
239 var accountInfo = action.AccountInfo;
241 using (log4net.ThreadContext.Stacks["NETWORK"].Push("PROCESS"))
243 Log.InfoFormat("[ACTION] Start Processing {0}", action);
245 var cloudFile = action.CloudFile;
249 //Acquire a lock on the deleted file to prevent uploading/downloading operations from the normal
251 using (var gate = NetworkGate.Acquire(action.LocalFile.FullName, NetworkOperation.Deleting))
254 //Add the file URL to the deleted files list
255 var key = GetFileKey(action.CloudFile);
256 _deletedFiles[key] = DateTime.Now;
259 // and then delete the file from the server
260 DeleteCloudFile(accountInfo, cloudFile);
262 Log.InfoFormat("[ACTION] End Delete {0}:{1}->{2}", action.Action, action.LocalFile,
263 action.CloudFile.Name);
266 catch (WebException exc)
268 Log.ErrorFormat("[WEB ERROR] {0} : {1} -> {2} due to exception\r\n{3}", action.Action, action.LocalFile, action.CloudFile, exc);
270 catch (OperationCanceledException)
274 catch (DirectoryNotFoundException)
276 Log.ErrorFormat("{0} : {1} -> {2} failed because the directory was not found.\n Rescheduling a delete",
277 action.Action, action.LocalFile, action.CloudFile);
278 //Repost a delete action for the missing file
279 _deleteAgent.Post(action);
281 catch (FileNotFoundException)
283 Log.ErrorFormat("{0} : {1} -> {2} failed because the file was not found.\n Rescheduling a delete",
284 action.Action, action.LocalFile, action.CloudFile);
285 //Post a delete action for the missing file
286 _deleteAgent.Post(action);
288 catch (Exception exc)
290 Log.ErrorFormat("[REQUEUE] {0} : {1} -> {2} due to exception\r\n{3}",
291 action.Action, action.LocalFile, action.CloudFile, exc);
293 _deleteAgent.Post(action);
297 //Set the event when all delete actions are processed
298 if (_deleteAgent.InputCount == 0)
305 private static string GetFileKey(ObjectInfo info)
307 var key = String.Format("{0}/{1}/{2}", info.Account, info.Container,info.Name);
311 private async Task SyncFiles(AccountInfo accountInfo,CloudAction action)
313 if (accountInfo == null)
314 throw new ArgumentNullException("accountInfo");
316 throw new ArgumentNullException("action");
317 if (action.LocalFile==null)
318 throw new ArgumentException("The action's local file is not specified","action");
319 if (!Path.IsPathRooted(action.LocalFile.FullName))
320 throw new ArgumentException("The action's local file path must be absolute","action");
321 if (action.CloudFile== null)
322 throw new ArgumentException("The action's cloud file is not specified", "action");
323 Contract.EndContractBlock();
325 var localFile = action.LocalFile;
326 var cloudFile = action.CloudFile;
327 var downloadPath=action.LocalFile.GetProperCapitalization();
329 var cloudHash = cloudFile.Hash.ToLower();
330 var localHash = action.LocalHash.Value.ToLower();
331 var topHash = action.TopHash.Value.ToLower();
333 //Not enough to compare only the local hashes, also have to compare the tophashes
335 //If any of the hashes match, we are done
336 if ((cloudHash == localHash || cloudHash == topHash))
338 Log.InfoFormat("Skipping {0}, hashes match",downloadPath);
342 //The hashes DON'T match. We need to sync
343 var lastLocalTime = localFile.LastWriteTime;
344 var lastUpTime = cloudFile.Last_Modified;
346 //If the local file is newer upload it
347 if (lastUpTime <= lastLocalTime)
349 //It probably means it was changed while the app was down
350 UploadCloudFile(action);
354 //It the cloud file has a later date, it was modified by another user or computer.
355 //We need to check the local file's status
356 var status = StatusKeeper.GetFileStatus(downloadPath);
359 case FileStatus.Unchanged:
360 //If the local file's status is Unchanged, we can go on and download the newer cloud file
361 await DownloadCloudFile(accountInfo,cloudFile,downloadPath);
363 case FileStatus.Modified:
364 //If the local file is Modified, we may have a conflict. In this case we should mark the file as Conflict
365 //We can't ensure that a file modified online since the last time will appear as Modified, unless we
366 //index all files before we start listening.
367 case FileStatus.Created:
368 //If the local file is Created, it means that the local and cloud files aren't related,
369 // yet they have the same name.
371 //In both cases we must mark the file as in conflict
372 ReportConflict(downloadPath);
375 //Other cases should never occur. Mark them as Conflict as well but log a warning
376 ReportConflict(downloadPath);
377 Log.WarnFormat("Unexcepted status {0} for file {1}->{2}", status,
378 downloadPath, action.CloudFile.Name);
384 private void ReportConflict(string downloadPath)
386 if (String.IsNullOrWhiteSpace(downloadPath))
387 throw new ArgumentNullException("downloadPath");
388 Contract.EndContractBlock();
390 StatusKeeper.SetFileOverlayStatus(downloadPath, FileOverlayStatus.Conflict);
391 UpdateStatus(PithosStatus.HasConflicts);
392 var message = String.Format("Conflict detected for file {0}", downloadPath);
394 StatusNotification.NotifyChange(message, TraceLevel.Warning);
397 public void Post(CloudAction cloudAction)
399 if (cloudAction == null)
400 throw new ArgumentNullException("cloudAction");
401 if (cloudAction.AccountInfo==null)
402 throw new ArgumentException("The CloudAction.AccountInfo is empty","cloudAction");
403 Contract.EndContractBlock();
407 //If the action targets a local file, add a treehash calculation
408 if (!(cloudAction is CloudDeleteAction) && cloudAction.LocalFile as FileInfo != null)
410 var accountInfo = cloudAction.AccountInfo;
411 var localFile = (FileInfo) cloudAction.LocalFile;
412 if (localFile.Length > accountInfo.BlockSize)
413 cloudAction.TopHash =
414 new Lazy<string>(() => Signature.CalculateTreeHashAsync(localFile,
415 accountInfo.BlockSize,
416 accountInfo.BlockHash).Result
417 .TopHash.ToHashString());
420 cloudAction.TopHash = new Lazy<string>(() => cloudAction.LocalHash.Value);
425 //The hash for a directory is the empty string
426 cloudAction.TopHash = new Lazy<string>(() => String.Empty);
429 if (cloudAction is CloudDeleteAction)
430 _deleteAgent.Post((CloudDeleteAction)cloudAction);
432 _agent.Post(cloudAction);
435 /* class ObjectInfoByNameComparer:IEqualityComparer<ObjectInfo>
437 public bool Equals(ObjectInfo x, ObjectInfo y)
439 return x.Name.Equals(y.Name,StringComparison.InvariantCultureIgnoreCase);
442 public int GetHashCode(ObjectInfo obj)
444 return obj.Name.ToLower().GetHashCode();
448 public void SynchNow()
451 _tcs.TrySetResult(true);
454 //TODO: This may be OK for testing purposes, but we have no guarantee that it will
455 //work properly in production
456 PollRemoteFiles(repeat:false);
460 //Remote files are polled periodically. Any changes are processed
461 public async Task PollRemoteFiles(DateTime? since = null,bool repeat=true)
463 UpdateStatus(PithosStatus.Syncing);
464 StatusNotification.Notify(new PollNotification());
466 using (log4net.ThreadContext.Stacks["Retrieve Remote"].Push("All accounts"))
468 //If this poll fails, we will retry with the same since value
469 var nextSince = since;
472 //Next time we will check for all changes since the current check minus 1 second
473 //This is done to ensure there are no discrepancies due to clock differences
474 DateTime current = DateTime.Now.AddSeconds(-1);
476 var tasks = from accountInfo in _accounts
477 select ProcessAccountFiles(accountInfo, since);
479 await TaskEx.WhenAll(tasks.ToList());
482 //Reschedule the poll with the current timestamp as a "since" value
490 Log.ErrorFormat("Error while processing accounts\r\n{0}",ex);
491 //In case of failure retry with the same "since" value
494 UpdateStatus(PithosStatus.InSynch);
495 //Wait for the polling interval to pass or the Manual flat to be toggled
496 nextSince = await WaitForScheduledOrManualPoll(nextSince);
498 PollRemoteFiles(nextSince);
503 private async Task<DateTime?> WaitForScheduledOrManualPoll(DateTime? since)
505 _tcs = new TaskCompletionSource<bool>();
506 var wait = TaskEx.Delay(TimeSpan.FromSeconds(Settings.PollingInterval), _agent.CancellationToken);
507 var signaledTask = await TaskEx.WhenAny(_tcs.Task, wait);
508 //If polling is signalled by SynchNow, ignore the since tag
509 if (signaledTask is Task<bool>)
514 public async Task ProcessAccountFiles(AccountInfo accountInfo,DateTime? since=null)
516 if (accountInfo==null)
517 throw new ArgumentNullException("accountInfo");
518 if (String.IsNullOrWhiteSpace(accountInfo.AccountPath))
519 throw new ArgumentException("The AccountInfo.AccountPath is empty","accountInfo");
520 Contract.EndContractBlock();
523 using (log4net.ThreadContext.Stacks["Retrieve Remote"].Push(accountInfo.UserName))
527 Log.Info("Scheduled");
528 var client=new CloudFilesClient(accountInfo);
530 var containers = client.ListContainers(accountInfo.UserName);
533 CreateContainerFolders(accountInfo, containers);
538 //Get the poll time now. We may miss some deletions but it's better to keep a file that was deleted
539 //than delete a file that was created while we were executing the poll
540 var pollTime = DateTime.Now;
542 //Get the list of server objects changed since the last check
543 //The name of the container is passed as state in order to create a dictionary of tasks in a subsequent step
544 var listObjects = (from container in containers
545 select Task<IList<ObjectInfo>>.Factory.StartNew(_ =>
546 client.ListObjects(accountInfo.UserName,container.Name, since),container.Name)).ToList();
548 var listShared = Task<IList<ObjectInfo>>.Factory.StartNew(_ => client.ListSharedObjects(since), "shared");
549 listObjects.Add(listShared);
550 var listTasks = await Task.Factory.WhenAll(listObjects.ToArray());
552 using (log4net.ThreadContext.Stacks["SCHEDULE"].Push("Process Results"))
554 var dict = listTasks.ToDictionary(t => t.AsyncState);
556 //Get all non-trash objects. Remember, the container name is stored in AsyncState
557 var remoteObjects = from objectList in listTasks
558 where (string) objectList.AsyncState != "trash"
559 from obj in objectList.Result
562 //TODO: Change the way deleted objects are detected.
563 //The list operation returns all existing objects so we could detect deleted remote objects
564 //by detecting objects that exist only locally. There are several cases where this is NOT the case:
565 //1. The first time the application runs, as there may be files that were added while
566 // the application was down.
567 //2. An object that is currently being uploaded will not appear in the remote list
568 // until the upload finishes.
569 // SOLUTION 1: Check the upload/download queue for the file
570 // SOLUTION 2: Check the SQLite states for the file's entry. If it is being uploaded,
571 // or its last modification was after the current poll, don't delete it. This way we don't
572 // delete objects whose upload finished too late to be included in the list.
573 //We need to detect and protect against such situations
574 //TODO: Does FileState have a LastModification field?
575 //TODO: How do we update the LastModification field? Do we need to add SQLite triggers?
576 // Do we need to use a proper SQLite schema?
577 // We can create a trigger with
578 // CREATE TRIGGER IF NOT EXISTS update_last_modified UPDATE ON FileState FOR EACH ROW
580 // UPDATE FileState SET LastModification=datetime('now') WHERE Id=old.Id;
583 //NOTE: Some files may have been deleted remotely while the application was down.
584 // We DO have to delete those files. Checking the trash makes it easy to detect them,
585 // Otherwise, we can't be really sure whether we need to upload or delete
586 // the local-only files.
587 // SOLUTION 1: Ask the user when such a local-only file is detected during the first poll.
588 // SOLUTION 2: Mark conflict and ask the user as in #1
590 var trashObjects = dict["trash"].Result;
591 var sharedObjects = dict["shared"].Result;
593 //Items with the same name, hash may be both in the container and the trash
594 //Don't delete items that exist in the container
595 var realTrash = from trash in trashObjects
598 info => info.Name == trash.Name && info.Hash == trash.Hash)
600 ProcessTrashedFiles(accountInfo, realTrash);
603 var cleanRemotes = (from info in remoteObjects.Union(sharedObjects)
605 where !name.EndsWith(".ignore", StringComparison.InvariantCultureIgnoreCase) &&
606 !name.StartsWith(FolderConstants.CacheFolder + "/",
607 StringComparison.InvariantCultureIgnoreCase)
608 select info).ToList();
612 ProcessDeletedFiles(accountInfo, cleanRemotes, pollTime);
614 //Create a list of actions from the remote files
615 var allActions = ObjectsToActions(accountInfo, cleanRemotes);
618 //var relativePath = objectInfo.RelativeUrlToFilePath(accountInfo.UserName);
620 //And remove those that are already being processed by the agent
621 var distinctActions = allActions
622 .Except(_agent.GetEnumerable(), new PithosMonitor.LocalFileComparer())
625 //Queue all the actions
626 foreach (var message in distinctActions)
631 Log.Info("[LISTENER] End Processing");
636 Log.ErrorFormat("[FAIL] ListObjects for{0} in ProcessRemoteFiles with {1}", accountInfo.UserName, ex);
640 Log.Info("[LISTENER] Finished");
646 /// Deletes local files that are not found in the list of cloud files
648 /// <param name="accountInfo"></param>
649 /// <param name="cloudFiles"></param>
650 /// <param name="pollTime"></param>
651 private void ProcessDeletedFiles(AccountInfo accountInfo, IEnumerable<ObjectInfo> cloudFiles, DateTime pollTime)
653 if (accountInfo == null)
654 throw new ArgumentNullException("accountInfo");
655 if (String.IsNullOrWhiteSpace(accountInfo.AccountPath))
656 throw new ArgumentException("The AccountInfo.AccountPath is empty", "accountInfo");
657 if (cloudFiles == null)
658 throw new ArgumentNullException("cloudFiles");
659 Contract.EndContractBlock();
661 //Check the Modified date to ensure that were just created and haven't been uploaded yet
662 //NOTE: The NHibernate LINQ provider doesn't support custom functions so we need to break the query
664 //NOTE: DON'T return files that are already in conflict. The first poll would mark them as
665 //"In Conflict" but subsequent polls would delete them
666 /* var t=FileState.Find(new Guid("{cd664c9a-5f17-47c9-b27f-3bcbcb0595ff}"));
668 var d0 = FileState.Queryable
670 state.FilePath.StartsWith(accountInfo.AccountPath)).ToList();
672 var d1 = FileState.Queryable
673 .Where(state => state.Modified <= pollTime).ToList();
674 var d2= FileState.Queryable
675 .Where(state => state.Modified <= pollTime
677 state.FilePath.StartsWith(accountInfo.AccountPath)).ToList();*/
679 //Consider for deleteion only files modified before the PREVIOUS poll
680 //A user may perform a file creation or rename at roughly the same time as a poll. In such a case
681 //the new file will appear as deleted
682 var previousPollTime = pollTime.Subtract(TimeSpan.FromMilliseconds(Settings.PollingInterval));
684 //Only consider files that are not being modified, ie they are in the Unchanged state
685 var deleteCandidates = FileState.Queryable.Where(state =>
686 state.Modified <= previousPollTime
687 && state.FilePath.StartsWith(accountInfo.AccountPath)
688 && state.FileStatus == FileStatus.Unchanged).ToList();
690 //TODO: filesToDelete must take into account the Others container
691 var filesToDelete = (from deleteCandidate in deleteCandidates
692 let localFile = FileInfoExtensions.FromPath(deleteCandidate.FilePath)
693 let relativeFilePath = localFile.AsRelativeTo(accountInfo.AccountPath)
694 let agentActions = _agent.GetEnumerable()
696 !_lastSeen.ContainsKey(localFile.FullName)
697 && !cloudFiles.Any(r => r.RelativeUrlToFilePath(accountInfo.UserName) == relativeFilePath )
698 //Exclude files enqueued for uploading
699 //Large files will not appear on the server for multiple polls. They must not be marked as deleted
700 && !agentActions.Any(action => action.LocalFile.WithProperCapitalization().FullName == localFile.FullName)
701 //Do NOT delete files modified since the previous poll
702 && localFile.LastAccessTime < previousPollTime
703 select localFile).ToList();
709 //Set the status of missing files to Conflict
710 foreach (var item in filesToDelete)
712 //Try to acquire a gate on the file, to take into account files that have been dequeued
713 //and are being processed
714 using (var gate = NetworkGate.Acquire(item.FullName, NetworkOperation.Deleting))
718 StatusKeeper.SetFileState(item.FullName, FileStatus.Conflict, FileOverlayStatus.Deleted);
721 UpdateStatus(PithosStatus.HasConflicts);
722 StatusNotification.NotifyConflicts(filesToDelete, String.Format("{0} local files are missing from Pithos, possibly because they were deleted",filesToDelete.Count));
726 foreach (var item in filesToDelete)
730 //Try to acquire a gate on the file, to take into account files that have been dequeued
731 //and are being processed
732 //TODO: The gate is not enough. Perhaps we need to keep a journal of processed files and check against
734 using (var gate = NetworkGate.Acquire(item.FullName, NetworkOperation.Deleting))
738 if ((item.Attributes & FileAttributes.ReadOnly) == FileAttributes.ReadOnly)
740 item.Attributes = item.Attributes & ~FileAttributes.ReadOnly;
746 StatusKeeper.ClearFileStatus(item.FullName);
748 StatusNotification.NotifyForFiles(filesToDelete, String.Format("{0} files were deleted",filesToDelete.Count),TraceLevel.Info);
753 private static void CreateContainerFolders(AccountInfo accountInfo, IEnumerable<ContainerInfo> containers)
755 var containerPaths = from container in containers
756 let containerPath = Path.Combine(accountInfo.AccountPath, container.Name)
757 where container.Name != FolderConstants.TrashContainer && !Directory.Exists(containerPath)
758 select containerPath;
760 foreach (var path in containerPaths)
762 Directory.CreateDirectory(path);
766 //Creates an appropriate action for each server file
767 private IEnumerable<CloudAction> ObjectsToActions(AccountInfo accountInfo,IEnumerable<ObjectInfo> remote)
770 throw new ArgumentNullException();
771 Contract.EndContractBlock();
772 var fileAgent = GetFileAgent(accountInfo);
774 //In order to avoid multiple iterations over the files, we iterate only once
775 //over the remote files
776 foreach (var objectInfo in remote)
778 var relativePath = objectInfo.RelativeUrlToFilePath(accountInfo.UserName);
779 //and remove any matching objects from the list, adding them to the commonObjects list
781 if (fileAgent.Exists(relativePath))
783 //If a directory object already exists, we don't need to perform any other action
784 var localFile = fileAgent.GetFileSystemInfo(relativePath);
785 if (objectInfo.Content_Type == @"application/directory" && localFile is DirectoryInfo)
787 using (new SessionScope(FlushAction.Never))
789 var state = StatusKeeper.GetStateByFilePath(localFile.FullName);
790 _lastSeen[localFile.FullName] = DateTime.Now;
791 //FileState.FindByFilePath(localFile.FullName);
792 //Common files should be checked on a per-case basis to detect differences, which is newer
794 yield return new CloudAction(accountInfo, CloudActionType.MustSynch,
795 localFile, objectInfo, state, accountInfo.BlockSize,
796 accountInfo.BlockHash);
801 //If there is no match we add them to the localFiles list
802 //but only if the file is not marked for deletion
803 var targetFile = Path.Combine(accountInfo.AccountPath, relativePath);
804 var fileStatus = StatusKeeper.GetFileStatus(targetFile);
805 if (fileStatus != FileStatus.Deleted)
807 //Remote files should be downloaded
808 yield return new CloudDownloadAction(accountInfo,objectInfo);
814 private static FileAgent GetFileAgent(AccountInfo accountInfo)
816 return AgentLocator<FileAgent>.Get(accountInfo.AccountPath);
819 private void ProcessTrashedFiles(AccountInfo accountInfo,IEnumerable<ObjectInfo> trashObjects)
821 var fileAgent = GetFileAgent(accountInfo);
822 foreach (var trashObject in trashObjects)
824 var barePath = trashObject.RelativeUrlToFilePath(accountInfo.UserName);
825 //HACK: Assume only the "pithos" container is used. Must find out what happens when
826 //deleting a file from a different container
827 var relativePath = Path.Combine("pithos", barePath);
828 fileAgent.Delete(relativePath);
833 private void RenameCloudFile(AccountInfo accountInfo,CloudMoveAction action)
835 if (accountInfo==null)
836 throw new ArgumentNullException("accountInfo");
838 throw new ArgumentNullException("action");
839 if (action.CloudFile==null)
840 throw new ArgumentException("CloudFile","action");
841 if (action.LocalFile==null)
842 throw new ArgumentException("LocalFile","action");
843 if (action.OldLocalFile==null)
844 throw new ArgumentException("OldLocalFile","action");
845 if (action.OldCloudFile==null)
846 throw new ArgumentException("OldCloudFile","action");
847 Contract.EndContractBlock();
850 var newFilePath = action.LocalFile.FullName;
852 //How do we handle concurrent renames and deletes/uploads/downloads?
853 //* A conflicting upload means that a file was renamed before it had a chance to finish uploading
854 // This should never happen as the network agent executes only one action at a time
855 //* A conflicting download means that the file was modified on the cloud. While we can go on and complete
856 // the rename, there may be a problem if the file is downloaded in blocks, as subsequent block requests for the
857 // same name will fail.
858 // This should never happen as the network agent executes only one action at a time.
859 //* A conflicting delete can happen if the rename was followed by a delete action that didn't have the chance
860 // to remove the rename from the queue.
861 // We can probably ignore this case. It will result in an error which should be ignored
864 //The local file is already renamed
865 StatusKeeper.SetFileOverlayStatus(newFilePath, FileOverlayStatus.Modified);
868 var account = action.CloudFile.Account ?? accountInfo.UserName;
869 var container = action.CloudFile.Container;
871 var client = new CloudFilesClient(accountInfo);
872 //TODO: What code is returned when the source file doesn't exist?
873 client.MoveObject(account, container, action.OldCloudFile.Name, container, action.CloudFile.Name);
875 StatusKeeper.SetFileStatus(newFilePath, FileStatus.Unchanged);
876 StatusKeeper.SetFileOverlayStatus(newFilePath, FileOverlayStatus.Normal);
877 NativeMethods.RaiseChangeNotification(newFilePath);
880 private void DeleteCloudFile(AccountInfo accountInfo, ObjectInfo cloudFile)
882 if (accountInfo == null)
883 throw new ArgumentNullException("accountInfo");
885 throw new ArgumentNullException("cloudFile");
887 if (String.IsNullOrWhiteSpace(cloudFile.Container))
888 throw new ArgumentException("Invalid container", "cloudFile");
889 Contract.EndContractBlock();
891 var fileAgent = GetFileAgent(accountInfo);
893 using ( log4net.ThreadContext.Stacks["DeleteCloudFile"].Push("Delete"))
895 var fileName= cloudFile.RelativeUrlToFilePath(accountInfo.UserName);
896 var info = fileAgent.GetFileSystemInfo(fileName);
897 var fullPath = info.FullName.ToLower();
899 StatusKeeper.SetFileOverlayStatus(fullPath, FileOverlayStatus.Modified);
901 var account = cloudFile.Account ?? accountInfo.UserName;
902 var container = cloudFile.Container ;//?? FolderConstants.PithosContainer;
904 var client = new CloudFilesClient(accountInfo);
905 client.DeleteObject(account, container, cloudFile.Name);
907 StatusKeeper.ClearFileStatus(fullPath);
912 private async Task DownloadCloudFile(AccountInfo accountInfo, ObjectInfo cloudFile , string filePath)
914 if (accountInfo == null)
915 throw new ArgumentNullException("accountInfo");
916 if (cloudFile == null)
917 throw new ArgumentNullException("cloudFile");
918 if (String.IsNullOrWhiteSpace(cloudFile.Account))
919 throw new ArgumentNullException("cloudFile");
920 if (String.IsNullOrWhiteSpace(cloudFile.Container))
921 throw new ArgumentNullException("cloudFile");
922 if (String.IsNullOrWhiteSpace(filePath))
923 throw new ArgumentNullException("filePath");
924 if (!Path.IsPathRooted(filePath))
925 throw new ArgumentException("The filePath must be rooted", "filePath");
926 Contract.EndContractBlock();
929 var localPath = Interfaces.FileInfoExtensions.GetProperFilePathCapitalization(filePath);
930 var relativeUrl = new Uri(cloudFile.Name, UriKind.Relative);
932 var url = relativeUrl.ToString();
933 if (cloudFile.Name.EndsWith(".ignore", StringComparison.InvariantCultureIgnoreCase))
937 //Are we already downloading or uploading the file?
938 using (var gate=NetworkGate.Acquire(localPath, NetworkOperation.Downloading))
942 //The file's hashmap will be stored in the same location with the extension .hashmap
943 //var hashPath = Path.Combine(FileAgent.CachePath, relativePath + ".hashmap");
945 var client = new CloudFilesClient(accountInfo);
946 var account = cloudFile.Account;
947 var container = cloudFile.Container;
949 if (cloudFile.Content_Type == @"application/directory")
951 if (!Directory.Exists(localPath))
952 Directory.CreateDirectory(localPath);
956 //Retrieve the hashmap from the server
957 var serverHash = await client.GetHashMap(account, container, url);
958 //If it's a small file
959 if (serverHash.Hashes.Count == 1)
960 //Download it in one go
962 DownloadEntireFileAsync(accountInfo, client, cloudFile, relativeUrl, localPath, serverHash);
963 //Otherwise download it block by block
965 await DownloadWithBlocks(accountInfo, client, cloudFile, relativeUrl, localPath, serverHash);
967 if (cloudFile.AllowedTo == "read")
969 var attributes = File.GetAttributes(localPath);
970 File.SetAttributes(localPath, attributes | FileAttributes.ReadOnly);
974 //Now we can store the object's metadata without worrying about ghost status entries
975 StatusKeeper.StoreInfo(localPath, cloudFile);
980 //Download a small file with a single GET operation
981 private async Task DownloadEntireFileAsync(AccountInfo accountInfo, CloudFilesClient client, ObjectInfo cloudFile, Uri relativeUrl, string filePath,TreeHash serverHash)
984 throw new ArgumentNullException("client");
986 throw new ArgumentNullException("cloudFile");
987 if (relativeUrl == null)
988 throw new ArgumentNullException("relativeUrl");
989 if (String.IsNullOrWhiteSpace(filePath))
990 throw new ArgumentNullException("filePath");
991 if (!Path.IsPathRooted(filePath))
992 throw new ArgumentException("The localPath must be rooted", "filePath");
993 Contract.EndContractBlock();
995 var localPath = Pithos.Interfaces.FileInfoExtensions.GetProperFilePathCapitalization(filePath);
996 //If the file already exists
997 if (File.Exists(localPath))
999 //First check with MD5 as this is a small file
1000 var localMD5 = Signature.CalculateMD5(localPath);
1001 var cloudHash=serverHash.TopHash.ToHashString();
1002 if (localMD5==cloudHash)
1004 //Then check with a treehash
1005 var localTreeHash = Signature.CalculateTreeHash(localPath, serverHash.BlockSize, serverHash.BlockHash);
1006 var localHash = localTreeHash.TopHash.ToHashString();
1007 if (localHash==cloudHash)
1010 StatusNotification.Notify(new CloudNotification { Data = cloudFile });
1012 var fileAgent = GetFileAgent(accountInfo);
1013 //Calculate the relative file path for the new file
1014 var relativePath = relativeUrl.RelativeUriToFilePath();
1015 //The file will be stored in a temporary location while downloading with an extension .download
1016 var tempPath = Path.Combine(fileAgent.CachePath, relativePath + ".download");
1017 //Make sure the target folder exists. DownloadFileTask will not create the folder
1018 var tempFolder = Path.GetDirectoryName(tempPath);
1019 if (!Directory.Exists(tempFolder))
1020 Directory.CreateDirectory(tempFolder);
1022 //Download the object to the temporary location
1023 await client.GetObject(cloudFile.Account, cloudFile.Container, relativeUrl.ToString(), tempPath);
1025 //Create the local folder if it doesn't exist (necessary for shared objects)
1026 var localFolder = Path.GetDirectoryName(localPath);
1027 if (!Directory.Exists(localFolder))
1028 Directory.CreateDirectory(localFolder);
1029 //And move it to its actual location once downloading is finished
1030 if (File.Exists(localPath))
1031 File.Replace(tempPath,localPath,null,true);
1033 File.Move(tempPath,localPath);
1034 //Notify listeners that a local file has changed
1035 StatusNotification.NotifyChangedFile(localPath);
1040 //Download a file asynchronously using blocks
1041 public async Task DownloadWithBlocks(AccountInfo accountInfo, CloudFilesClient client, ObjectInfo cloudFile, Uri relativeUrl, string filePath, TreeHash serverHash)
1044 throw new ArgumentNullException("client");
1045 if (cloudFile == null)
1046 throw new ArgumentNullException("cloudFile");
1047 if (relativeUrl == null)
1048 throw new ArgumentNullException("relativeUrl");
1049 if (String.IsNullOrWhiteSpace(filePath))
1050 throw new ArgumentNullException("filePath");
1051 if (!Path.IsPathRooted(filePath))
1052 throw new ArgumentException("The filePath must be rooted", "filePath");
1053 if (serverHash == null)
1054 throw new ArgumentNullException("serverHash");
1055 Contract.EndContractBlock();
1057 var fileAgent = GetFileAgent(accountInfo);
1058 var localPath = Interfaces.FileInfoExtensions.GetProperFilePathCapitalization(filePath);
1060 //Calculate the relative file path for the new file
1061 var relativePath = relativeUrl.RelativeUriToFilePath();
1062 var blockUpdater = new BlockUpdater(fileAgent.CachePath, localPath, relativePath, serverHash);
1066 //Calculate the file's treehash
1067 var treeHash = await Signature.CalculateTreeHashAsync(localPath, serverHash.BlockSize, serverHash.BlockHash);
1069 //And compare it with the server's hash
1070 var upHashes = serverHash.GetHashesAsStrings();
1071 var localHashes = treeHash.HashDictionary;
1072 for (int i = 0; i < upHashes.Length; i++)
1074 //For every non-matching hash
1075 var upHash = upHashes[i];
1076 if (!localHashes.ContainsKey(upHash))
1078 StatusNotification.Notify(new CloudNotification { Data = cloudFile });
1080 if (blockUpdater.UseOrphan(i, upHash))
1082 Log.InfoFormat("[BLOCK GET] ORPHAN FOUND for {0} of {1} for {2}", i, upHashes.Length, localPath);
1085 Log.InfoFormat("[BLOCK GET] START {0} of {1} for {2}", i, upHashes.Length, localPath);
1086 var start = i*serverHash.BlockSize;
1087 //To download the last block just pass a null for the end of the range
1089 if (i < upHashes.Length - 1 )
1090 end= ((i + 1)*serverHash.BlockSize) ;
1092 //Download the missing block
1093 var block = await client.GetBlock(cloudFile.Account, cloudFile.Container, relativeUrl, start, end);
1096 blockUpdater.StoreBlock(i, block);
1099 Log.InfoFormat("[BLOCK GET] FINISH {0} of {1} for {2}", i, upHashes.Length, localPath);
1103 //Want to avoid notifications if no changes were made
1104 var hasChanges = blockUpdater.HasBlocks;
1105 blockUpdater.Commit();
1108 //Notify listeners that a local file has changed
1109 StatusNotification.NotifyChangedFile(localPath);
1111 Log.InfoFormat("[BLOCK GET] COMPLETE {0}", localPath);
1115 private async Task UploadCloudFile(CloudAction action)
1118 throw new ArgumentNullException("action");
1119 Contract.EndContractBlock();
1123 var accountInfo = action.AccountInfo;
1125 var fileInfo = action.LocalFile;
1127 if (fileInfo.Extension.Equals("ignore", StringComparison.InvariantCultureIgnoreCase))
1130 var relativePath = fileInfo.AsRelativeTo(accountInfo.AccountPath);
1131 if (relativePath.StartsWith(FolderConstants.OthersFolder))
1133 var parts = relativePath.Split('\\');
1134 var accountName = parts[1];
1135 var oldName = accountInfo.UserName;
1136 var absoluteUri = accountInfo.StorageUri.AbsoluteUri;
1137 var nameIndex = absoluteUri.IndexOf(oldName);
1138 var root = absoluteUri.Substring(0, nameIndex);
1140 accountInfo = new AccountInfo
1142 UserName = accountName,
1143 AccountPath = Path.Combine(accountInfo.AccountPath, parts[0], parts[1]),
1144 StorageUri = new Uri(root + accountName),
1145 BlockHash = accountInfo.BlockHash,
1146 BlockSize = accountInfo.BlockSize,
1147 Token = accountInfo.Token
1152 var fullFileName = fileInfo.GetProperCapitalization();
1153 using (var gate = NetworkGate.Acquire(fullFileName, NetworkOperation.Uploading))
1155 //Abort if the file is already being uploaded or downloaded
1159 var cloudFile = action.CloudFile;
1160 var account = cloudFile.Account ?? accountInfo.UserName;
1162 var client = new CloudFilesClient(accountInfo);
1163 //Even if GetObjectInfo times out, we can proceed with the upload
1164 var info = client.GetObjectInfo(account, cloudFile.Container, cloudFile.Name);
1166 //If this is a read-only file, do not upload changes
1167 if (info.AllowedTo == "read")
1170 //TODO: Check how a directory hash is calculated -> All dirs seem to have the same hash
1171 if (fileInfo is DirectoryInfo)
1173 //If the directory doesn't exist the Hash property will be empty
1174 if (String.IsNullOrWhiteSpace(info.Hash))
1175 //Go on and create the directory
1176 await client.PutObject(account, cloudFile.Container, cloudFile.Name, fullFileName, String.Empty, "application/directory");
1181 var cloudHash = info.Hash.ToLower();
1183 var hash = action.LocalHash.Value;
1184 var topHash = action.TopHash.Value;
1186 //If the file hashes match, abort the upload
1187 if (hash == cloudHash || topHash == cloudHash)
1189 //but store any metadata changes
1190 StatusKeeper.StoreInfo(fullFileName, info);
1191 Log.InfoFormat("Skip upload of {0}, hashes match", fullFileName);
1196 //Mark the file as modified while we upload it
1197 StatusKeeper.SetFileOverlayStatus(fullFileName, FileOverlayStatus.Modified);
1198 //And then upload it
1200 //Upload even small files using the Hashmap. The server may already contain
1201 //the relevant block
1203 //First, calculate the tree hash
1204 var treeHash = await Signature.CalculateTreeHashAsync(fullFileName, accountInfo.BlockSize,
1205 accountInfo.BlockHash);
1207 await UploadWithHashMap(accountInfo, cloudFile, fileInfo as FileInfo, cloudFile.Name, treeHash);
1209 //If everything succeeds, change the file and overlay status to normal
1210 StatusKeeper.SetFileState(fullFileName, FileStatus.Unchanged, FileOverlayStatus.Normal);
1212 //Notify the Shell to update the overlays
1213 NativeMethods.RaiseChangeNotification(fullFileName);
1214 StatusNotification.NotifyChangedFile(fullFileName);
1216 catch (AggregateException ex)
1218 var exc = ex.InnerException as WebException;
1220 throw ex.InnerException;
1221 if (HandleUploadWebException(action, exc))
1225 catch (WebException ex)
1227 if (HandleUploadWebException(action, ex))
1231 catch (Exception ex)
1233 Log.Error("Unexpected error while uploading file", ex);
1239 private bool IsDeletedFile(CloudAction action)
1241 var key = GetFileKey(action.CloudFile);
1243 if (_deletedFiles.TryGetValue(key, out entryDate))
1245 //If the delete entry was created after this action, abort the action
1246 if (entryDate > action.Created)
1248 //Otherwise, remove the stale entry
1249 _deletedFiles.TryRemove(key, out entryDate);
1254 private bool HandleUploadWebException(CloudAction action, WebException exc)
1256 var response = exc.Response as HttpWebResponse;
1257 if (response == null)
1259 if (response.StatusCode == HttpStatusCode.Unauthorized)
1261 Log.Error("Not allowed to upload file", exc);
1262 var message = String.Format("Not allowed to uplad file {0}", action.LocalFile.FullName);
1263 StatusKeeper.SetFileState(action.LocalFile.FullName, FileStatus.Unchanged, FileOverlayStatus.Normal);
1264 StatusNotification.NotifyChange(message, TraceLevel.Warning);
1270 public async Task UploadWithHashMap(AccountInfo accountInfo,ObjectInfo cloudFile,FileInfo fileInfo,string url,TreeHash treeHash)
1272 if (accountInfo == null)
1273 throw new ArgumentNullException("accountInfo");
1274 if (cloudFile==null)
1275 throw new ArgumentNullException("cloudFile");
1276 if (fileInfo == null)
1277 throw new ArgumentNullException("fileInfo");
1278 if (String.IsNullOrWhiteSpace(url))
1279 throw new ArgumentNullException(url);
1281 throw new ArgumentNullException("treeHash");
1282 if (String.IsNullOrWhiteSpace(cloudFile.Container) )
1283 throw new ArgumentException("Invalid container","cloudFile");
1284 Contract.EndContractBlock();
1286 var fullFileName = fileInfo.GetProperCapitalization();
1288 var account = cloudFile.Account ?? accountInfo.UserName;
1289 var container = cloudFile.Container ;
1291 var client = new CloudFilesClient(accountInfo);
1292 //Send the hashmap to the server
1293 var missingHashes = await client.PutHashMap(account, container, url, treeHash);
1294 //If the server returns no missing hashes, we are done
1295 while (missingHashes.Count > 0)
1298 var buffer = new byte[accountInfo.BlockSize];
1299 foreach (var missingHash in missingHashes)
1301 //Find the proper block
1302 var blockIndex = treeHash.HashDictionary[missingHash];
1303 var offset = blockIndex*accountInfo.BlockSize;
1305 var read = fileInfo.Read(buffer, offset, accountInfo.BlockSize);
1309 //And upload the block
1310 await client.PostBlock(account, container, buffer, 0, read);
1311 Log.InfoFormat("[BLOCK] Block {0} of {1} uploaded", blockIndex, fullFileName);
1313 catch (Exception exc)
1315 Log.ErrorFormat("[ERROR] uploading block {0} of {1}\n{2}", blockIndex, fullFileName, exc);
1320 //Repeat until there are no more missing hashes
1321 missingHashes = await client.PutHashMap(account, container, url, treeHash);
1326 public void AddAccount(AccountInfo accountInfo)
1328 if (!_accounts.Contains(accountInfo))
1329 _accounts.Add(accountInfo);