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

   1 //
   2 // Microsoft.TeamFoundation.VersionControl.Client.ExtendedItem
   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.IO;
  32 using System.Net;
  33 using System.Text;
  34 using System.Xml;
  35 using System.Web.Services;
  36
  37 namespace Microsoft.TeamFoundation.VersionControl.Client
  38 {
  39         public sealed class ExtendedItem
  40         {
  41                 private ChangeType changeType = ChangeType.None;
  42                 private int deletionId;
  43                 private int encoding;
  44                 private int itemId;
  45                 private string localItem;
  46                 private string sourceServerItem;
  47                 private string targetServerItem;
  48                 private string lockOwner;
  49                 private bool hasOtherPendingChange;
  50                 private ItemType itemType;
  51                 private LockLevel lockStatus;
  52                 private int versionLatest;
  53                 private int versionLocal;
  54
  55                 //<ExtendedItem lver="int" did="int" latest="int"
  56                 //type="Any or Folder or File" enc="int" itemid="int"
  57                 //local="string" titem="string" sitem="string"
  58                 //chg="None or Add or Edit or Encoding or Rename or Delete or Undelete or Branch or Merge or Lock"
  59                 //ochg="boolean" lock="None or Checkin or CheckOut or Unchanged"
  60                 //lowner="string" />
  61
  62                 internal static ExtendedItem FromXml(Repository repository, XmlReader reader)
  63                 {
  64                         ExtendedItem item = new ExtendedItem();
  65
  66                         string chg = reader.GetAttribute("chg");
  67                         if (!String.IsNullOrEmpty(chg)) item.changeType = (ChangeType) Enum.Parse(typeof(ChangeType), chg, true);
  68
  69                         string ochg = reader.GetAttribute("ochg");
  70                         if (!String.IsNullOrEmpty(ochg)) item.hasOtherPendingChange = bool.Parse(ochg);
  71
  72                         string xlock = reader.GetAttribute("lock");
  73                         if (!String.IsNullOrEmpty(xlock)) item.lockStatus = (LockLevel) Enum.Parse(typeof(LockLevel), xlock, true);
  74
  75                         item.lockOwner = reader.GetAttribute("lowner");
  76                         item.localItem = TfsPath.ToPlatformPath(reader.GetAttribute("local"));
  77                         item.targetServerItem = reader.GetAttribute("titem");
  78                         item.sourceServerItem = reader.GetAttribute("sitem");
  79
  80                         item.itemType = (ItemType) Enum.Parse(typeof(ItemType), reader.GetAttribute("type"), true);
  81                         item.itemId = Convert.ToInt32(reader.GetAttribute("itemid"));
  82                         item.encoding = Convert.ToInt32(reader.GetAttribute("enc"));
  83                         item.versionLocal = Convert.ToInt32(reader.GetAttribute("lver"));
  84                         item.versionLatest = Convert.ToInt32(reader.GetAttribute("latest"));
  85                         item.deletionId = Convert.ToInt32(reader.GetAttribute("did"));
  86
  87                         return item;
  88                 }
  89
  90                 public override string ToString()
  91                 {
  92                         StringBuilder sb = new StringBuilder();
  93
  94                         sb.Append("ExtendedItem instance ");
  95                         sb.Append(GetHashCode());
  96
  97                         sb.Append("\n    LockOwner: ");
  98                         sb.Append(LockOwner);
  99
 100                         sb.Append("\n    HasOtherPendingChange: ");
 101                         sb.Append(HasOtherPendingChange);
 102
 103                         sb.Append("\n    ChangeType: ");
 104                         sb.Append(ChangeType);
 105
 106                         sb.Append("\n    LockStatus: ");
 107                         sb.Append(LockStatus.ToString());
 108
 109                         sb.Append("\n    VersionLocal: ");
 110                         sb.Append(VersionLocal);
 111
 112                         sb.Append("\n    VersionLatest: ");
 113                         sb.Append(VersionLatest);
 114
 115                         sb.Append("\n    Encoding: ");
 116                         sb.Append(Encoding);
 117
 118                         sb.Append("\n    LocalItem: ");
 119                         sb.Append(LocalItem);
 120
 121                         sb.Append("\n    TargetServerItem: ");
 122                         sb.Append(TargetServerItem);
 123
 124                         sb.Append("\n    SourceServerItem: ");
 125                         sb.Append(SourceServerItem);
 126
 127                         sb.Append("\n    ItemId: ");
 128                         sb.Append(ItemId);
 129
 130                         sb.Append("\n    ItemType: ");
 131                         sb.Append(ItemType);
 132
 133                         sb.Append("\n    DeletionId: ");
 134                         sb.Append(DeletionId);
 135
 136                         return sb.ToString();
 137                 }
 138
 139                 public int VersionLatest
 140                 {
 141                         get { return versionLatest; }
 142                 }
 143
 144                 public int VersionLocal
 145                 {
 146                         get { return versionLocal; }
 147                 }
 148
 149                 public LockLevel LockStatus
 150                 {
 151                         get { return lockStatus; }
 152                 }
 153
 154                 public ItemType ItemType
 155                 {
 156                         get { return itemType; }
 157                 }
 158
 159                 public ChangeType ChangeType
 160                 {
 161                         get { return changeType; }
 162                 }
 163
 164                 public int DeletionId
 165                 {
 166                         get { return deletionId; }
 167                 }
 168
 169                 public bool HasOtherPendingChange
 170                 {
 171                         get { return hasOtherPendingChange; }
 172                 }
 173
 174                 public bool IsInWorkspace
 175                 {
 176                         get { return (!String.IsNullOrEmpty(LocalItem)); }
 177                 }
 178
 179                 public bool IsLatest
 180                 {
 181                         get { return versionLatest == versionLocal; }
 182                 }
 183
 184                 public int ItemId
 185                 {
 186                         get { return itemId; }
 187                 }
 188
 189                 public int Encoding
 190                 {
 191                         get { return encoding; }
 192                 }
 193
 194                 public string LocalItem
 195                 {
 196                         get { return localItem; }
 197                 }
 198
 199                 public string LockOwner
 200                 {
 201                         get { return lockOwner; }
 202                 }
 203
 204                 public string SourceServerItem
 205                 {
 206                         get { return sourceServerItem; }
 207                 }
 208
 209                 public string TargetServerItem
 210                 {
 211                         get { return targetServerItem; }
 212                 }
 213
 214         }
 215 }
 216