class/Microsoft.TeamFoundation.VersionControl.Client/Item.cs

   1 //
   2 // Microsoft.TeamFoundation.VersionControl.Client.Item
   3 //
   4 // Authors:
   5 //      Joel Reed (joelwreed@gmail.com)
   6 //
   7 // Copyright (C) 2007 Joel Reed
   8 //
   9 // Permission is hereby granted, free of charge, to any person obtaining
  10 // a copy of this software and associated documentation files (the
  11 // "Software"), to deal in the Software without restriction, including
  12 // without limitation the rights to use, copy, modify, merge, publish,
  13 // distribute, sublicense, and/or sell copies of the Software, and to
  14 // permit persons to whom the Software is furnished to do so, subject to
  15 // the following conditions:
  16 //
  17 // The above copyright notice and this permission notice shall be
  18 // included in all copies or substantial portions of the Software.
  19 //
  20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27 //
  28
  29 using System;
  30 using System.Collections;
  31 using System.Collections.Generic;
  32 using System.IO;
  33 using System.Net;
  34 using System.Text;
  35 using System.Xml;
  36 using System.Web.Services;
  37
  38 namespace Microsoft.TeamFoundation.VersionControl.Client
  39 {
  40         public sealed class Item
  41         {
  42                 private string downloadUrl;
  43                 private int contentLength;
  44                 private int changesetId;
  45                 private int deletionId;
  46                 private int encoding;
  47                 private byte[] hashValue;
  48                 private int itemId;
  49                 private DateTime checkinDate;
  50                 private ItemType itemType = ItemType.File;
  51                 private string serverItem;
  52                 private VersionControlServer versionControlServer;
  53
  54                 internal Item (VersionControlServer versionControlServer, string serverItem)
  55                 {
  56                         this.versionControlServer = versionControlServer;
  57                         this.serverItem = serverItem;
  58                 }
  59
  60                 public void DownloadFile(string localFileName)
  61                 {
  62                         if (itemType == ItemType.Folder) return;
  63
  64                         Client.DownloadFile.WriteTo(localFileName, VersionControlServer.Repository,
  65                                                                                                                                         ArtifactUri);
  66                 }
  67
  68                 //              <?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Body><QueryItemsResponse xmlns="http://schemas.microsoft.com/TeamFoundation/2005/06/VersionControl/ClientServices/03"><QueryItemsResult><ItemSet><QueryPath>$/LSG-1.0</QueryPath><Pattern>*</Pattern><Item cs="7550" date="2006-07-31T18:28:33.933Z" enc="1252" type="File" itemid="41475" item="$/LSG-1.0/configure" hash="KW/KR55BW9qI4Fcg0cEVJQ==" len="146815" durl="sfid=62793,109833,108681,62795,72164,108744,72943,87351,72163,21458&amp;ts=633006048546770184&amp;s=ZNoNAgB8PlCgbs2Lqc4
  69                 //zH21A4SRFW3edqRcbnRKOeC%2F1IZ02f%2FHe8EdYvcU8PNwnBPhBGSGgaKcQWNjPussH3LgjhxQLzxZsfXQWDAllOnbf%2BrOMQYY30SF9e4R4eUjg1wccIkUpkEMOv1edrteyDu5H5ZjISxHQWhLTJ4OyJQ%3D&amp;fid=72164" /><Item cs="7043" date="2006-06-14T20:33:16.16Z" enc="-3" type="Folder" itemid="41609" item="$/LSG-1.0/db" hash="" />
  70                 internal static Item FromXml(Repository repository, XmlReader reader)
  71                 {
  72                         string serverItem = reader.GetAttribute("item");
  73
  74                         Item item = new Item(repository.VersionControlServer, serverItem);
  75
  76                         string itype = reader.GetAttribute("type");
  77                         if (!String.IsNullOrEmpty(itype))
  78                                 item.itemType = (ItemType) Enum.Parse(typeof(ItemType), itype, true);
  79
  80                         string sdate = reader.GetAttribute("date");
  81                         if (!String.IsNullOrEmpty(sdate))
  82                                 item.checkinDate = DateTime.Parse(sdate);
  83
  84                         item.changesetId = Convert.ToInt32(reader.GetAttribute("cs"));
  85                         item.itemId = Convert.ToInt32(reader.GetAttribute("itemid"));
  86                         item.encoding = Convert.ToInt32(reader.GetAttribute("enc"));
  87
  88                         if (item.ItemType == ItemType.File)
  89                                 {
  90                                         item.contentLength = Convert.ToInt32(reader.GetAttribute("len"));
  91                                         item.downloadUrl = reader.GetAttribute("durl");
  92
  93                                         string hash = reader.GetAttribute("hash");
  94                                         if (!String.IsNullOrEmpty(hash))
  95                                                 item.hashValue = Convert.FromBase64String(hash);
  96                                 }
  97
  98                         return item;
  99                 }
 100
 101                 public override string ToString()
 102                 {
 103                         StringBuilder sb = new StringBuilder();
 104
 105                         sb.Append("Item instance ");
 106                         sb.Append(GetHashCode());
 107
 108                         sb.Append("\n    ItemId: ");
 109                         sb.Append(ItemId);
 110
 111                         sb.Append("\n    CheckinDate: ");
 112                         sb.Append(CheckinDate.ToString("s"));
 113
 114                         sb.Append("\n    ChangesetId: ");
 115                         sb.Append(ChangesetId);
 116
 117                         sb.Append("\n    DeletionId: ");
 118                         sb.Append(DeletionId);
 119
 120                         sb.Append("\n    ItemType: ");
 121                         sb.Append(ItemType);
 122
 123                         sb.Append("\n    ServerItem: ");
 124                         sb.Append(ServerItem);
 125
 126                         sb.Append("\n    ContentLength: ");
 127                         sb.Append(ContentLength);
 128
 129                         sb.Append("\n    Download URL: ");
 130                         sb.Append(downloadUrl);
 131
 132                         sb.Append("\n    Hash: ");
 133                         string hash = String.Empty;
 134                         if (HashValue != null) hash = Convert.ToBase64String(HashValue);
 135                         sb.Append(hash);
 136
 137                         return sb.ToString();
 138                 }
 139
 140                 public int ContentLength
 141                 {
 142                         get { return contentLength; }
 143                 }
 144
 145                 public ItemType ItemType
 146                 {
 147                         get { return itemType; }
 148                 }
 149
 150                 public DateTime CheckinDate
 151                 {
 152                         get { return checkinDate; }
 153                 }
 154
 155                 public int ChangesetId
 156                 {
 157                         get { return changesetId; }
 158                 }
 159
 160                 public int DeletionId
 161                 {
 162                         get { return deletionId; }
 163                 }
 164
 165                 public int Encoding
 166                 {
 167                         get { return encoding; }
 168                 }
 169
 170                 public int ItemId
 171                 {
 172                         get { return itemId; }
 173                 }
 174
 175                 public byte[] HashValue
 176                 {
 177                         get { return hashValue; }
 178                 }
 179
 180                 public Uri ArtifactUri
 181                 {
 182                         get
 183                                 {
 184                                         if (String.IsNullOrEmpty(downloadUrl))
 185                                                 {
 186                                                         Item item = VersionControlServer.GetItem(ItemId, ChangesetId, true);
 187                                                         downloadUrl = item.downloadUrl;
 188                                                 }
 189
 190                                         return new Uri(String.Format("{0}?{1}", VersionControlServer.Repository.ItemUrl, downloadUrl));
 191                                 }
 192                 }
 193
 194                 public string ServerItem
 195                 {
 196                         get { return serverItem; }
 197                 }
 198
 199                 public VersionControlServer VersionControlServer
 200                 {
 201                         get { return versionControlServer; }
 202                 }
 203
 204                 internal class ItemGenericComparer : IComparer<Item>
 205                 {
 206                         public static ItemGenericComparer Instance = new ItemGenericComparer();
 207
 208                         public int Compare(Item x, Item y)
 209                         {
 210                                 return x.ServerItem.CompareTo(y.ServerItem);
 211                         }
 212                 }
 213
 214                 internal static IComparer<Item> GenericComparer {
 215                         get {
 216                                 return ItemGenericComparer.Instance;
 217                         }
 218                 }
 219
 220                 internal class ItemComparer : IComparer
 221                 {
 222                         public static ItemComparer Instance = new ItemComparer();
 223
 224                         public int Compare(object x, object y)
 225                         {
 226                                 Item itemX = (Item)x;
 227                                 Item itemY = (Item)y;
 228                                 return itemX.ServerItem.CompareTo(itemY.ServerItem);
 229                         }
 230                 }
 231
 232                 public static IComparer Comparer {
 233                         get {
 234                                 return ItemComparer.Instance;
 235                         }
 236                 }
 237
 238         }
 239 }
 240