duplicati/Duplicati/Library/Main/Operation/Backup/MetadataPreProcess.cs

//  Copyright (C) 2015, The Duplicati Team
//  http://www.duplicati.com, info@duplicati.com
//
//  This library is free software; you can redistribute it and/or modify
//  it under the terms of the GNU Lesser General Public License as
//  published by the Free Software Foundation; either version 2.1 of the
//  License, or (at your option) any later version.
//
//  This library is distributed in the hope that it will be useful, but
//  WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
//  Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public
//  License along with this library; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
using System;
using CoCoL;
using System.Threading.Tasks;
using System.IO;
using System.Collections.Generic;
using Duplicati.Library.Interface;
using Duplicati.Library.Main.Operation.Common;

namespace Duplicati.Library.Main.Operation.Backup
{
    /// <summary>
    /// This class processes paths for metadata and emits the metadata blocks for storage.
    /// Folders and symlinks in the database, and paths are forwarded to be scanned for changes
    /// </summary>
    internal static class MetadataPreProcess
    {
        public class FileEntry
        {
            // From input
            public string Path;

            // From database
            public long OldId;
            public DateTime OldModified;
            public long LastFileSize;
            public string OldMetaHash;
            public long OldMetaSize;

            // From filedata
            public DateTime LastWrite;
            public FileAttributes Attributes;

            // After processing metadata
            public IMetahash MetaHashAndSize;
            public bool MetadataChanged;
        }
            
        public static Task Run(Snapshots.ISnapshotService snapshot, Options options, BackupDatabase database)
        {
            return AutomationExtensions.RunTask(new
            {
                Input = Backup.Channels.SourcePaths.ForRead,
                LogChannel = Common.Channels.LogChannel.ForWrite,
                Output = Backup.Channels.ProcessedFiles.ForWrite,
                BlockOutput = Backup.Channels.OutputBlocks.ForWrite
            },
                
            async self =>
            {
                var log = new LogWrapper(self.LogChannel);
                var emptymetadata = Utility.WrapMetadata(new Dictionary<string, string>(), options);
                var blocksize = options.Blocksize;

                while (true)
                {
                    var path = await self.Input.ReadAsync();

                    var lastwrite = new DateTime(0, DateTimeKind.Utc);
                    var attributes = default(FileAttributes);
                    try 
                    { 
                        lastwrite = snapshot.GetLastWriteTimeUtc(path); 
                    }
                    catch (Exception ex) 
                    {
                        await log.WriteWarningAsync(string.Format("Failed to read timestamp on \"{0}\"", path), ex);
                    }

                    try 
                    { 
                        attributes = snapshot.GetAttributes(path); 
                    }
                    catch (Exception ex) 
                    {
                        await log.WriteWarningAsync(string.Format("Failed to read attributes on \"{0}\"", path), ex);
                    }

                    // If we only have metadata, stop here
                    if (await ProcessMetadata(path, attributes, lastwrite, options, log, snapshot, emptymetadata, blocksize, database, self.BlockOutput))
                    {
                        try
                        {
                            var res = await database.GetFileEntryAsync(path);

                            await self.Output.WriteAsync(new FileEntry() {
                                OldId = res == null ? -1 : res.id,
                                Path = path,
                                Attributes = attributes,
                                LastWrite = lastwrite,
                                OldModified = res == null ? new DateTime(0) : res.modified,
                                LastFileSize = res == null ? -1 : res.filesize,
                                OldMetaHash = res == null ? null : res.metahash,
                                OldMetaSize = res == null ? -1 : res.metasize
                            });
                        }
                        catch(Exception ex)
                        {
                            await log.WriteErrorAsync(string.Format("Failed to process entry, path: {0}", path), ex);
                        }
                    }
                }

            });

        }

        /// <summary>
        /// Processes the metadata for the given path.
        /// </summary>
        /// <returns><c>True</c> if the path should be submitted to more analysis, <c>false</c> if there is nothing else to do</returns>
        private static async Task<bool> ProcessMetadata(string path, FileAttributes attributes, DateTime lastwrite, Options options, LogWrapper log, Snapshots.ISnapshotService snapshot, IMetahash emptymetadata, long blocksize, BackupDatabase database, IWriteChannel<DataBlock> blockoutput)
        {
            if ((attributes & FileAttributes.ReparsePoint) == FileAttributes.ReparsePoint)
            {
                if (options.SymlinkPolicy == Options.SymlinkStrategy.Ignore)
                {
                    await log.WriteVerboseAsync("Ignoring symlink {0}", path);
                    return false;
                }

                if (options.SymlinkPolicy == Options.SymlinkStrategy.Store)
                {
                    var metadata = await MetadataGenerator.GenerateMetadataAsync(path, attributes, options, snapshot, log);

                    if (!metadata.ContainsKey("CoreSymlinkTarget"))
                    {
                        var p = snapshot.GetSymlinkTarget(path);

                        if (string.IsNullOrWhiteSpace(p))
                            await log.WriteVerboseAsync("Ignoring empty symlink {0}", path);
                        else
                            metadata["CoreSymlinkTarget"] = p;
                    }

                    var metahash = Utility.WrapMetadata(metadata, options);
                    await AddSymlinkToOutputAsync(path, DateTime.UtcNow, metahash, blocksize, database, blockoutput);

                    await log.WriteVerboseAsync("Stored symlink {0}", path);
                    // Don't process further
                    return false;
                }
            }

            if ((attributes & FileAttributes.Directory) == FileAttributes.Directory)
            {
                IMetahash metahash;

                if (options.StoreMetadata)
                {
                    metahash = Utility.WrapMetadata(await MetadataGenerator.GenerateMetadataAsync(path, attributes, options, snapshot, log), options);
                }
                else
                {
                    metahash = emptymetadata;
                }

                await log.WriteVerboseAsync("Adding directory {0}", path);
                await AddFolderToOutputAsync(path, lastwrite, metahash, blocksize, database, blockoutput);
                return false;
            }

            // Regular file, keep going
            return true;
        }

        /// <summary>
        /// Adds a file to the output, 
        /// </summary>
        /// <param name="filename">The name of the file to record</param>
        /// <param name="lastModified">The value of the lastModified timestamp</param>
        /// <param name="hashlist">The list of hashes that make up the file</param>
        /// <param name="size">The size of the file</param>
        /// <param name="fragmentoffset">The offset into a fragment block where the last few bytes are stored</param>
        /// <param name="metadata">A lookup table with various metadata values describing the file</param>
        private static async Task AddFolderToOutputAsync(string filename, DateTime lastModified, IMetahash meta, long blocksize, BackupDatabase database, IWriteChannel<DataBlock> blockoutput)
        {
            if (meta.Size > blocksize)
                throw new InvalidDataException(string.Format("Too large metadata, cannot handle more than {0} bytes", blocksize));

            await DataBlock.AddBlockToOutputAsync(blockoutput, meta.Hash, meta.Blob, 0, meta.Size, CompressionHint.Default, false);
            var metadataid = await database.AddMetadatasetAsync(meta.Hash, meta.Size);
            await database.AddDirectoryEntryAsync(filename, metadataid.Item2, lastModified);
        }

        /// <summary>
        /// Adds a file to the output, 
        /// </summary>
        /// <param name="filename">The name of the file to record</param>
        /// <param name="lastModified">The value of the lastModified timestamp</param>
        /// <param name="hashlist">The list of hashes that make up the file</param>
        /// <param name="size">The size of the file</param>
        /// <param name="fragmentoffset">The offset into a fragment block where the last few bytes are stored</param>
        /// <param name="metadata">A lookup table with various metadata values describing the file</param>
        private static async Task AddSymlinkToOutputAsync(string filename, DateTime lastModified, IMetahash meta, long blocksize, BackupDatabase database, IWriteChannel<DataBlock> blockoutput)
        {
            if (meta.Size > blocksize)
                throw new InvalidDataException(string.Format("Too large metadata, cannot handle more than {0} bytes", blocksize));

            await DataBlock.AddBlockToOutputAsync(blockoutput, meta.Hash, meta.Blob, 0, (int)meta.Size, CompressionHint.Default, false);
            var metadataid = await database.AddMetadatasetAsync(meta.Hash, meta.Size);
            await database.AddSymlinkEntryAsync(filename, metadataid.Item2, lastModified);
        }

    }
}