Как я могу использовать msbuild для загрузки файла?

Есть ли встроенный способ загрузки файла в локальный каталог с использованием HTTP?

Я могу раскошелиться на wget или написать пользовательскую задачу, но я хотел убедиться, что не существует способа выполнить это.

Заранее спасибо!


person Michael    schedule 06.07.2009    source источник


Ответы (5)


В Заданиях сообщества MSBuild есть задача WebDownload, которая кажется вам необходимой.

person Bas Bossink    schedule 06.07.2009

В MSBuild 4.0 вы можете использовать встроенные задачи, чтобы избежать необходимости компилировать и развертывать пользовательскую задачу в отдельной сборке.

  <UsingTask TaskName="DownloadFile" TaskFactory="CodeTaskFactory" AssemblyFile="$(MSBuildToolsPath)\Microsoft.Build.Tasks.v4.0.dll">
    <ParameterGroup>
      <Address ParameterType="System.String" Required="true"/>
      <FileName ParameterType="System.String" Required="true" />
    </ParameterGroup>
    <Task>
      <Reference Include="System" />
      <Code Type="Fragment" Language="cs">
        <![CDATA[
            new System.Net.WebClient().DownloadFile(Address, FileName);
        ]]>
      </Code>
    </Task>
  </UsingTask>

  <Target Name="DownloadSomething">
    <DownloadFile Address="http://somewebsite/remotefile" FileName="localfilepath" />
  </Target>
person Jason Stangroome    schedule 05.10.2012
comment
Когда я впервые прочитал это, было не очевидно, куда поместить два элемента. Я добавил «UsingTask» над «ItemGroup», содержащей файлы моего проекта, и поместил «DownloadFile» в «Target Name=AfterBuild». - person carlin.scott; 02.07.2015
comment
К сожалению, это не работает с версией MSBuild для dotnet core. - person sakra; 12.05.2017

Если вы пытаетесь загрузить файл, требующий проверки подлинности (например, TFS Web или сервер IIS, подключенный к домену), ни пакет расширений MSBuild, ни задачи сообщества MSBuild, по-видимому, не имеют возможности указать имя пользователя или пароль для HTTP-сервер. В этом случае я написал пользовательскую задачу MSBuild. Вот что я сделал.

Я последовал совету пользователя Stack Overflow Дуга в его ответе на Загрузить файл, требующий аутентификации с использованием vb.net/c#?, в котором он предлагает добавить некоторый код к методу, написанному Томом Арчером на веб-сайте Code Guru.

Поэтому я использовал MS Visual Studio 2010 для создания нового проекта C# со следующим кодом для создания цели MSBuild с именем Wget (показан полный исходный код):

// Include references to the following frameworks in your solution:
// - Microsoft.Build.Framework
// - Microsoft.Build.Utilities.v4.0
// - System
// - System.Net

using System;
using System.Net;
using System.IO;

using Microsoft.Build.Framework;
using Microsoft.Build.Utilities;

namespace Wget
{
    public class Wget: Task
    {
        [Required]
        public String Address // HTTP address to access
        { get; set; }

        [Required]
        public String LocalFilename // Local file to which the downloaded page will be saved
        { get; set; }

        public String Username // Credential for HTTP authentication
        { get; set; }

        public String Password // Credential for HTTP authentication
        { get; set; }

        public override bool Execute()
        {
            int read = DownloadFile(Address, LocalFilename, Username, Password);

            Console.WriteLine("{0} bytes written", read);

            return true;
        }

        public static int DownloadFile(String remoteFilename, String localFilename, String httpUsername, String httpPassword)
        {
            // Function will return the number of bytes processed
            // to the caller. Initialize to 0 here.
            int bytesProcessed = 0;

            // Assign values to these objects here so that they can
            // be referenced in the finally block
            Stream remoteStream = null;
            Stream localStream = null;
            WebResponse response = null;

            // Use a try/catch/finally block as both the WebRequest and Stream
            // classes throw exceptions upon error
            try
            {
                // Create a request for the specified remote file name
                WebRequest request = WebRequest.Create(remoteFilename);
                if (request != null)
                {
                    // If a username or password have been given, use them
                    if (httpUsername.Length > 0 || httpPassword.Length > 0)
                    {
                        string username = httpUsername;
                        string password = httpPassword;
                        request.Credentials = new System.Net.NetworkCredential(username, password);
                    }

                    // Send the request to the server and retrieve the
                    // WebResponse object 
                    response = request.GetResponse();
                    if (response != null)
                    {
                        // Once the WebResponse object has been retrieved,
                        // get the stream object associated with the response's data
                        remoteStream = response.GetResponseStream();

                        // Create the local file
                        localStream = File.Create(localFilename);

                        // Allocate a 1k buffer
                        byte[] buffer = new byte[1024];
                        int bytesRead;

                        // Simple do/while loop to read from stream until
                        // no bytes are returned
                        do
                        {
                            // Read data (up to 1k) from the stream
                            bytesRead = remoteStream.Read(buffer, 0, buffer.Length);

                            // Write the data to the local file
                            localStream.Write(buffer, 0, bytesRead);

                            // Increment total bytes processed
                            bytesProcessed += bytesRead;
                        } while (bytesRead > 0);
                    }
                }
            }
            catch (Exception e)
            {
                Console.WriteLine(e.Message);
            }
            finally
            {
                // Close the response and streams objects here 
                // to make sure they're closed even if an exception
                // is thrown at some point
                if (response != null) response.Close();
                if (remoteStream != null) remoteStream.Close();
                if (localStream != null) localStream.Close();
            }

            // Return total bytes processed to caller.
            return bytesProcessed;
        }
    }
}

Имея это на месте, я могу добавить следующую задачу в свой проект MSBuild:

<!-- Get the contents of a Url-->
<Wget
    Address="http://mywebserver.com/securepage"
    LocalFilename="mydownloadedfile.html"
    Username="myusername"
    Password="mypassword">
</Wget>

Задача Wget загружает страницу, обслуживаемую mywebserver.com, и сохраняет ее в файле в текущем рабочем каталоге как mydownloadedfile.html, используя имя пользователя «myusername» и пароль «mypassword».

Однако, чтобы использовать пользовательскую задачу Wget MSBuild, я должен указать MSBuild, где найти файл сборки Wget (.dll). Это делается с помощью элемента MSBuild:

<!-- Import your custom MSBuild task -->
<UsingTask AssemblyFile="MyCustomMSBuildTasks\Wget\bin\Release\Wget.dll" TaskName="Wget" />

Если вы хотите пофантазировать, вы даже можете сделать так, чтобы ваш проект MSBuild собирал Wget до того, как он будет вызван. Для этого создайте решение с задачей <MSBuild Projects> и импортируйте его с задачей <UsingTaks AssemblyFile> примерно так:

<!-- Build the custom MSBuild target solution-->
<MSBuild Projects="MyCustomMSBuildTasks\CustomBuildTasks.sln" Properties="Configuration=Release" />

<!-- Import your custom MSBuild task -->
<UsingTask AssemblyFile="MyCustomMSBuildTasks\Wget\bin\Release\Wget.dll" TaskName="Wget" />

<!-- Get the contents of a Url-->
<Wget
    Address="http://mywebserver.com/securepage"
    LocalFilename="mydownloadedfile.html"
    Username="myusername"
    Password="mypassword">
</Wget>

Если вы никогда раньше не создавали пользовательскую цель MSBuild, это не так уж сложно — если вы знаете основы. Посмотрите на приведенный выше код C#, взгляните на официальную документацию MSDN и поищите в Интернете дополнительные примеры. Хорошее место для начала:

person Steve HHH    schedule 02.06.2011
comment
Веб-загрузка communitytask теперь поддерживает аутентификацию. - person rasjani; 20.12.2016

Задача DownloadFile доступна в MSBuild 15.8 и более поздних версиях (с 14 августа 2018 г.).

пример:

    <PropertyGroup>  
      <LicenceUrl>https://raw.githubusercontent.com/Microsoft/msbuild/master/LICENSE</LicenceUrl>
    </PropertyGroup>  

    <Target Name="DownloadContentFiles" BeforeTargets="Build">
        <DownloadFile
            SourceUrl="$(LicenceUrl)"
            DestinationFolder="$(MSBuildProjectDirectory)">
        <Output TaskParameter="DownloadedFile" ItemName="Content" />
      </DownloadFile>
    </Target>

Дополнительные сведения: задача DownloadFile

person M.Hassan    schedule 17.10.2018

В дополнение к задаче WebDownload в проекте MSBuild Community Tasks пакет расширений MSBuild (текущая версия: 4.x) имеет класс WebClient, который можно использовать для загрузки файла. Вы можете скачать пакет расширения MSBuild здесь:

Вот пример использования MSBuild Extension Pack 4 для загрузки файла:

<Project ToolsVersion="4.0" DefaultTargets="Default" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<PropertyGroup>
    <TPath>$(MSBuildProjectDirectory)\..\MSBuild.ExtensionPack.tasks</TPath>
    <TPath Condition="Exists('$(MSBuildProjectDirectory)\..\..\Common\MSBuild.ExtensionPack.tasks')">$(MSBuildProjectDirectory)\..\..\Common\MSBuild.ExtensionPack.tasks</TPath>
</PropertyGroup>
<Import Project="$(TPath)"/>
<Target Name="Default">
    <!-- Download a File-->
    <MSBuild.ExtensionPack.Web.WebClient TaskAction="DownloadFile" Url="http://hlstiw.bay.livefilestore.com/y1p7GhsJWeF4ig_Yb-8QXeA1bL0nY_MdOGaRQ3opRZS0YVvfshMfoZYe_cb1wSzPhx4nL_yidkG8Ji9msjRcTt0ew/Team%20Build%202008%20DeskSheet%202.0.pdf?download" FileName="C:\TFS Build 2008 DeskSheet.pdf"/>
    <!-- Get the contents of a Url-->
    <MSBuild.ExtensionPack.Web.WebClient TaskAction="OpenRead" Url="http://www.msbuildextensionpack.com">
        <Output TaskParameter="Data" PropertyName="Out"/>
    </MSBuild.ExtensionPack.Web.WebClient>
    <Message Text="$(Out)"/>
</Target>

As mentioned in a different answer, WebClient does not appear to have the capability to download from a secure (password protected) web server.

person Steve HHH    schedule 02.06.2011