dotnet-installer/src/dotnet/commands/dotnet-add-p2p/Program.cs

// Copyright (c) .NET Foundation and contributors. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

using System.Collections.Generic;
using Microsoft.DotNet.Cli.CommandLine;
using Microsoft.DotNet.Cli.Utils;
using System;
using System.IO;
using System.Linq;
using Microsoft.Build.Construction;
using Microsoft.Build.Evaluation;
using Microsoft.DotNet.Tools.Common;

namespace Microsoft.DotNet.Tools.Add.ProjectToProjectReference
{
    public class AddProjectToProjectReferenceCommand
    {
        public static int Run(string[] args)
        {
            DebugHelper.HandleDebugSwitch(ref args);

            CommandLineApplication app = new CommandLineApplication(throwOnUnexpectedArg: false)
            {
                Name = "dotnet add p2p",
                FullName = ".NET Add Project to Project (p2p) reference Command",
                Description = "Command to add project to project (p2p) reference",
                AllowArgumentSeparator = true,
                ArgumentSeparatorHelpText = "Project to project references to add"
            };

            app.HelpOption("-h|--help");

            CommandArgument projectArgument = app.Argument(
                "<PROJECT>",
                "The project file to modify. If a project file is not specified," +
                " it searches the current working directory for an MSBuild file that has" +
                " a file extension that ends in `proj` and uses that file.");

            CommandOption frameworkOption = app.Option(
                "-f|--framework <FRAMEWORK>",
                "Add reference only when targetting a specific framework",
                CommandOptionType.SingleValue);

            CommandOption forceOption = app.Option(
                "--force", 
                "Add reference even if it does not exist, do not convert paths to relative",
                CommandOptionType.NoValue);

            app.OnExecute(() => {
                if (string.IsNullOrEmpty(projectArgument.Value))
                {
                    throw new GracefulException(LocalizableStrings.RequiredArgumentNotPassed, "<Project>");
                }

                ProjectRootElement project;
                string projectDir;
                if (File.Exists(projectArgument.Value))
                {
                    project = GetProjectFromFileOrThrow(projectArgument.Value);
                    projectDir = new FileInfo(projectArgument.Value).DirectoryName;
                }
                else
                {
                    project = GetProjectFromDirectoryOrThrow(projectArgument.Value);
                    projectDir = projectArgument.Value;
                }

                projectDir = PathUtility.EnsureTrailingSlash(projectDir);

                if (app.RemainingArguments.Count == 0)
                {
                    throw new GracefulException(LocalizableStrings.SpecifyAtLeastOneReference);
                }

                List<string> references = app.RemainingArguments;
                if (!forceOption.HasValue())
                {
                    EnsureAllReferencesExist(references);
                    ConvertPathsToRelative(projectDir, ref references);
                }
                
                int numberOfAddedReferences = AddProjectToProjectReference(
                    project,
                    frameworkOption.Value(),
                    references);

                if (numberOfAddedReferences != 0)
                {
                    project.Save();
                }

                return 0;
            });

            try
            {
                return app.Execute(args);
            }
            catch (GracefulException e)
            {
                Reporter.Error.WriteLine(e.Message.Red());
                app.ShowHelp();
                return 1;
            }
        }

        internal static void EnsureAllReferencesExist(List<string> references)
        {
            var notExisting = new List<string>();
            foreach (var r in references)
            {
                if (!File.Exists(r))
                {
                    notExisting.Add(r);
                }
            }

            if (notExisting.Count > 0)
            {
                throw new GracefulException(
                    string.Join(
                        Environment.NewLine,
                        notExisting.Select((r) => string.Format(LocalizableStrings.ReferenceDoesNotExist, r))));
            }
        }

        internal static void ConvertPathsToRelative(string root, ref List<string> references)
        {
            root = PathUtility.EnsureTrailingSlash(Path.GetFullPath(root));
            references = references.Select((r) => PathUtility.GetRelativePath(root, Path.GetFullPath(r))).ToList();
        }

        // There is ProjectRootElement.TryOpen but it does not work as expected
        // I.e. it returns null for some valid projects
        internal static ProjectRootElement TryOpenProject(string filename)
        {
            try
            {
                return ProjectRootElement.Open(filename, new ProjectCollection(), preserveFormatting: true);
            }
            catch (Microsoft.Build.Exceptions.InvalidProjectFileException)
            {
                return null;
            }
        }

        internal static ProjectRootElement GetProjectFromFileOrThrow(string filename)
        {
            if (!File.Exists(filename))
            {
                throw new GracefulException(LocalizableStrings.ProjectDoesNotExist, filename);
            }

            var project = TryOpenProject(filename);
            if (project == null)
            {
                throw new GracefulException(LocalizableStrings.ProjectIsInvalid, filename);
            }

            return project;
        }

        internal static ProjectRootElement GetProjectFromDirectoryOrThrow(string directory)
        {
            DirectoryInfo dir;
            try
            {
                dir = new DirectoryInfo(directory);
            }
            catch (ArgumentException)
            {
                throw new GracefulException(LocalizableStrings.CouldNotFindProjectOrDirectory, directory);
            }

            if (!dir.Exists)
            {
                throw new GracefulException(LocalizableStrings.CouldNotFindProjectOrDirectory, directory);
            }

            FileInfo[] files = dir.GetFiles("*proj");
            if (files.Length == 0)
            {
                throw new GracefulException(LocalizableStrings.CouldNotFindAnyProjectInDirectory, directory);
            }

            if (files.Length > 1)
            {
                throw new GracefulException(LocalizableStrings.MoreThanOneProjectInDirectory, directory);
            }

            FileInfo projectFile = files.First();

            if (!projectFile.Exists)
            {
                throw new GracefulException(LocalizableStrings.CouldNotFindAnyProjectInDirectory, directory);
            }

            var ret = TryOpenProject(projectFile.FullName);
            if (ret == null)
            {
                throw new GracefulException(LocalizableStrings.FoundInvalidProject, projectFile.FullName);
            }

            return ret;
        }

        private static string NormalizeSlashesForMsbuild(string path)
        {
            return path.Replace('/', '\\');
        }

        internal static int AddProjectToProjectReference(ProjectRootElement root, string framework, IEnumerable<string> refs)
        {
            int numberOfAddedReferences = 0;
            const string ProjectItemElementType = "ProjectReference";

            ProjectItemGroupElement itemGroup = root.FindUniformOrCreateItemGroupWithCondition(ProjectItemElementType, framework);
            foreach (var @ref in refs.Select((r) => NormalizeSlashesForMsbuild(r)))
            {
                if (root.HasExistingItemWithCondition(framework, @ref))
                {
                    Reporter.Output.WriteLine(string.Format(LocalizableStrings.ProjectAlreadyHasAreference, @ref));
                    continue;
                }

                numberOfAddedReferences++;
                itemGroup.AppendChild(root.CreateItemElement(ProjectItemElementType, @ref));

                Reporter.Output.WriteLine(string.Format(LocalizableStrings.ReferenceAddedToTheProject, @ref));
            }

            return numberOfAddedReferences;
        }
    }
}