org.eclipse.egit.ui/src/org/eclipse/egit/ui/internal/decorators/DecoratableResourceAdapter.java

   1 /*******************************************************************************
   2  * Copyright (C) 2007, IBM Corporation and others
   3  * Copyright (C) 2007, Dave Watson <dwatson@mimvista.com>
   4  * Copyright (C) 2008, Robin Rosenberg <robin.rosenberg@dewire.com>
   5  * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
   6  * Copyright (C) 2008, Google Inc.
   7  * Copyright (C) 2008, Tor Arne Vestbø <torarnv@gmail.com>
   8  *
   9  * All rights reserved. This program and the accompanying materials
  10  * are made available under the terms of the Eclipse Public License v1.0
  11  * which accompanies this distribution, and is available at
  12  * http://www.eclipse.org/legal/epl-v10.html
  13  *******************************************************************************/
  14
  15 package org.eclipse.egit.ui.internal.decorators;
  16
  17 import java.io.File;
  18 import java.io.IOException;
  19 import java.util.Collections;
  20 import java.util.Set;
  21
  22 import org.eclipse.core.resources.IProject;
  23 import org.eclipse.core.resources.IResource;
  24 import org.eclipse.core.resources.IWorkspaceRoot;
  25 import org.eclipse.egit.core.AdaptableFileTreeIterator;
  26 import org.eclipse.egit.core.ContainerTreeIterator;
  27 import org.eclipse.egit.core.ContainerTreeIterator.ResourceEntry;
  28 import org.eclipse.egit.core.project.RepositoryMapping;
  29 import org.eclipse.egit.ui.Activator;
  30 import org.eclipse.egit.ui.UIPreferences;
  31 import org.eclipse.jface.preference.IPreferenceStore;
  32 import org.eclipse.team.core.Team;
  33 import org.eclipse.jgit.dircache.DirCache;
  34 import org.eclipse.jgit.dircache.DirCacheEntry;
  35 import org.eclipse.jgit.dircache.DirCacheIterator;
  36 import org.eclipse.jgit.errors.IncorrectObjectTypeException;
  37 import org.eclipse.jgit.errors.MissingObjectException;
  38 import org.eclipse.jgit.lib.Constants;
  39 import org.eclipse.jgit.lib.FileMode;
  40 import org.eclipse.jgit.lib.ObjectId;
  41 import org.eclipse.jgit.lib.Repository;
  42 import org.eclipse.jgit.revwalk.RevWalk;
  43 import org.eclipse.jgit.treewalk.EmptyTreeIterator;
  44 import org.eclipse.jgit.treewalk.TreeWalk;
  45 import org.eclipse.jgit.treewalk.WorkingTreeIterator;
  46 import org.eclipse.jgit.treewalk.filter.AndTreeFilter;
  47 import org.eclipse.jgit.treewalk.filter.PathFilterGroup;
  48 import org.eclipse.jgit.treewalk.filter.TreeFilter;
  49
  50 class DecoratableResourceAdapter implements IDecoratableResource {
  51
  52         private final IResource resource;
  53
  54         private final RepositoryMapping mapping;
  55
  56         private final Repository repository;
  57
  58         private final ObjectId headId;
  59
  60         private final IPreferenceStore store;
  61
  62         private String branch = ""; //$NON-NLS-1$
  63
  64         private final String repositoryName;
  65
  66         private boolean tracked = false;
  67
  68         private boolean ignored = false;
  69
  70         private boolean dirty = false;
  71
  72         private boolean conflicts = false;
  73
  74         private boolean assumeValid = false;
  75
  76         private Staged staged = Staged.NOT_STAGED;
  77
  78         static final int T_HEAD = 0;
  79
  80         static final int T_INDEX = 1;
  81
  82         static final int T_WORKSPACE = 2;
  83
  84         @SuppressWarnings("fallthrough")
  85         public DecoratableResourceAdapter(IResource resourceToWrap)
  86                         throws IOException {
  87                 resource = resourceToWrap;
  88                 mapping = RepositoryMapping.getMapping(resource);
  89                 repository = mapping.getRepository();
  90                 headId = repository.resolve(Constants.HEAD);
  91
  92                 store = Activator.getDefault().getPreferenceStore();
  93
  94                 File gitDir = repository.getDirectory();
  95                 if (gitDir != null)
  96                         repositoryName = repository.getDirectory().getParentFile()
  97                                         .getName();
  98                 else
  99                         repositoryName = ""; //$NON-NLS-1$
 100                 // TODO: Add option to shorten branch name to 6 chars if it's a SHA
 101                 branch = repository.getBranch();
 102
 103                 TreeWalk treeWalk = createThreeWayTreeWalk();
 104                 if (treeWalk == null)
 105                         return;
 106
 107                 switch (resource.getType()) {
 108                 case IResource.FILE:
 109                         if (!treeWalk.next())
 110                                 return;
 111                         extractResourceProperties(treeWalk);
 112                         break;
 113                 case IResource.PROJECT:
 114                         tracked = true;
 115                 case IResource.FOLDER:
 116                         extractContainerProperties(treeWalk);
 117                         break;
 118                 }
 119         }
 120
 121         private void extractResourceProperties(TreeWalk treeWalk) {
 122                 final ContainerTreeIterator workspaceIterator = treeWalk.getTree(
 123                                 T_WORKSPACE, ContainerTreeIterator.class);
 124                 final ResourceEntry resourceEntry = workspaceIterator != null ? workspaceIterator
 125                                 .getResourceEntry() : null;
 126
 127                 if (resourceEntry == null)
 128                         return;
 129
 130                 if (isIgnored(resourceEntry.getResource())) {
 131                         ignored = true;
 132                         return;
 133                 }
 134
 135                 final int mHead = treeWalk.getRawMode(T_HEAD);
 136                 final int mIndex = treeWalk.getRawMode(T_INDEX);
 137
 138                 if (mHead == FileMode.MISSING.getBits()
 139                                 && mIndex == FileMode.MISSING.getBits())
 140                         return;
 141
 142                 tracked = true;
 143
 144                 if (mHead == FileMode.MISSING.getBits()) {
 145                         staged = Staged.ADDED;
 146                 } else if (mIndex == FileMode.MISSING.getBits()) {
 147                         staged = Staged.REMOVED;
 148                 } else if (mHead != mIndex
 149                                 || (mIndex != FileMode.TREE.getBits() && !treeWalk.idEqual(
 150                                                 T_HEAD, T_INDEX))) {
 151                         staged = Staged.MODIFIED;
 152                 } else {
 153                         staged = Staged.NOT_STAGED;
 154                 }
 155
 156                 final DirCacheIterator indexIterator = treeWalk.getTree(T_INDEX,
 157                                 DirCacheIterator.class);
 158                 final DirCacheEntry indexEntry = indexIterator != null ? indexIterator
 159                                 .getDirCacheEntry() : null;
 160
 161                 if (indexEntry == null)
 162                         return;
 163
 164                 if (indexEntry.getStage() > 0)
 165                         conflicts = true;
 166
 167                 if (indexEntry.isAssumeValid()) {
 168                         dirty = false;
 169                         assumeValid = true;
 170                 } else {
 171                         if (!timestampMatches(indexEntry, resourceEntry))
 172                                 dirty = true;
 173
 174                         // TODO: Consider doing a content check here, to rule out false
 175                         // positives, as we might get mismatch between timestamps, even
 176                         // if the content is the same.
 177                 }
 178         }
 179
 180         private class RecursiveStateFilter extends TreeFilter {
 181
 182                 private int filesChecked = 0;
 183
 184                 private int targetDepth = -1;
 185
 186                 private final int recurseLimit;
 187
 188                 public RecursiveStateFilter() {
 189                         recurseLimit = store
 190                                         .getInt(UIPreferences.DECORATOR_RECURSIVE_LIMIT);
 191                 }
 192
 193                 @Override
 194                 public boolean include(TreeWalk treeWalk)
 195                                 throws MissingObjectException, IncorrectObjectTypeException,
 196                                 IOException {
 197
 198                         if (treeWalk.getFileMode(T_HEAD) == FileMode.MISSING
 199                                         && treeWalk.getFileMode(T_INDEX) == FileMode.MISSING)
 200                                 return false;
 201
 202                         if (FileMode.TREE.equals(treeWalk.getRawMode(T_WORKSPACE)))
 203                                 return shouldRecurse(treeWalk);
 204
 205                         // Backup current state so far
 206                         Staged wasStaged = staged;
 207                         boolean wasDirty = dirty;
 208                         boolean hadConflicts = conflicts;
 209
 210                         extractResourceProperties(treeWalk);
 211                         filesChecked++;
 212
 213                         // Merge results with old state
 214                         ignored = false;
 215                         assumeValid = false;
 216                         dirty = wasDirty || dirty;
 217                         conflicts = hadConflicts || conflicts;
 218                         if (staged != wasStaged && filesChecked > 1)
 219                                 staged = Staged.MODIFIED;
 220
 221                         return false;
 222                 }
 223
 224                 private boolean shouldRecurse(TreeWalk treeWalk) {
 225                         final WorkingTreeIterator workspaceIterator = treeWalk.getTree(
 226                                         T_WORKSPACE, WorkingTreeIterator.class);
 227
 228                         if (workspaceIterator instanceof AdaptableFileTreeIterator)
 229                                 return true;
 230
 231                         ResourceEntry resourceEntry = null;
 232                         if (workspaceIterator != null)
 233                                 resourceEntry = ((ContainerTreeIterator) workspaceIterator)
 234                                                 .getResourceEntry();
 235
 236                         if (resourceEntry == null)
 237                                 return true;
 238
 239                         IResource visitingResource = resourceEntry.getResource();
 240                         if (targetDepth == -1) {
 241                                 if (visitingResource.equals(resource)
 242                                                 || visitingResource.getParent().equals(resource))
 243                                         targetDepth = treeWalk.getDepth();
 244                                 else
 245                                         return true;
 246                         }
 247
 248                         if ((treeWalk.getDepth() - targetDepth) >= recurseLimit) {
 249                                 if (visitingResource.equals(resource))
 250                                         extractResourceProperties(treeWalk);
 251
 252                                 return false;
 253                         }
 254
 255                         return true;
 256                 }
 257
 258                 @Override
 259                 public TreeFilter clone() {
 260                         RecursiveStateFilter clone = new RecursiveStateFilter();
 261                         clone.filesChecked = this.filesChecked;
 262                         return clone;
 263                 }
 264
 265                 @Override
 266                 public boolean shouldBeRecursive() {
 267                         return true;
 268                 }
 269         }
 270
 271         private void extractContainerProperties(TreeWalk treeWalk) throws IOException {
 272
 273                 if (isIgnored(resource)) {
 274                         ignored = true;
 275                         return;
 276                 }
 277
 278                 treeWalk.setFilter(AndTreeFilter.create(treeWalk.getFilter(),
 279                                 new RecursiveStateFilter()));
 280                 treeWalk.setRecursive(true);
 281
 282                 treeWalk.next();
 283         }
 284
 285         /**
 286          * Adds a filter to the specified tree walk limiting the results to only
 287          * those matching the resource specified by <code>resourceToFilterBy</code>
 288          * <p>
 289          * If the resource does not exists in the current repository, no filter is
 290          * added and the method returns <code>false</code>. If the resource is a
 291          * project, no filter is added, but the operation is considered a success.
 292          *
 293          * @param treeWalk
 294          *            the tree walk to add the filter to
 295          * @param resourceToFilterBy
 296          *            the resource to filter by
 297          *
 298          * @return <code>true</code> if the filter could be added,
 299          *         <code>false</code> otherwise
 300          */
 301         private boolean addResourceFilter(final TreeWalk treeWalk,
 302                         final IResource resourceToFilterBy) {
 303                 Set<String> repositoryPaths = Collections.singleton(mapping
 304                                 .getRepoRelativePath(resourceToFilterBy));
 305                 if (repositoryPaths.isEmpty())
 306                         return false;
 307
 308                 if (repositoryPaths.contains("")) //$NON-NLS-1$
 309                         return true; // Project filter
 310
 311                 treeWalk.setFilter(PathFilterGroup.createFromStrings(repositoryPaths));
 312                 return true;
 313         }
 314
 315         /**
 316          * Helper method to create a new tree walk between the repository, the
 317          * index, and the working tree.
 318          *
 319          * @return the created tree walk, or null if it could not be created
 320          * @throws IOException
 321          *             if there were errors when creating the tree walk
 322          */
 323         private TreeWalk createThreeWayTreeWalk() throws IOException {
 324                 final TreeWalk treeWalk = new TreeWalk(repository);
 325                 if (!addResourceFilter(treeWalk, resource))
 326                         return null;
 327
 328                 treeWalk.setRecursive(treeWalk.getFilter().shouldBeRecursive());
 329                 treeWalk.reset();
 330
 331                 // Repository
 332                 if (headId != null)
 333                         treeWalk.addTree(new RevWalk(repository).parseTree(headId));
 334                 else
 335                         treeWalk.addTree(new EmptyTreeIterator());
 336
 337                 // Index
 338                 treeWalk.addTree(new DirCacheIterator(DirCache.read(repository)));
 339
 340                 // Working directory
 341                 IProject project = resource.getProject();
 342                 IWorkspaceRoot workspaceRoot = resource.getWorkspace().getRoot();
 343                 File repoRoot = repository.getWorkDir();
 344
 345                 if (repoRoot.equals(project.getLocation().toFile()))
 346                         treeWalk.addTree(new ContainerTreeIterator(project));
 347                 else if (repoRoot.equals(workspaceRoot.getLocation().toFile()))
 348                         treeWalk.addTree(new ContainerTreeIterator(workspaceRoot));
 349                 else
 350                         treeWalk.addTree(new AdaptableFileTreeIterator(repoRoot,
 351                                         workspaceRoot));
 352
 353                 return treeWalk;
 354         }
 355
 356         private static boolean timestampMatches(DirCacheEntry indexEntry,
 357                         ResourceEntry resourceEntry) {
 358                 long tIndex = indexEntry.getLastModified();
 359                 long tWorkspaceResource = resourceEntry.getLastModified();
 360
 361
 362                 // C-Git under Windows stores timestamps with 1-seconds resolution,
 363                 // so we need to check to see if this is the case here, and possibly
 364                 // fix the timestamp of the resource to match the resolution of the
 365                 // index.
 366                 // It also appears the timestamp in Java on Linux may also be rounded
 367                 // in which case the index timestamp may have subseconds, but not
 368                 // the timestamp from the workspace resource.
 369                 // If either timestamp looks rounded we skip the subscond part.
 370                 if (tIndex % 1000 == 0 || tWorkspaceResource % 1000 == 0) {
 371                         return tIndex / 1000 == tWorkspaceResource / 1000;
 372                 } else {
 373                         return tIndex == tWorkspaceResource;
 374                 }
 375         }
 376
 377         private static boolean isIgnored(IResource resource) {
 378                 // TODO: Also read ignores from .git/info/excludes et al.
 379                 return Team.isIgnoredHint(resource);
 380         }
 381
 382         public String getName() {
 383                 return resource.getName();
 384         }
 385
 386         public int getType() {
 387                 return resource.getType();
 388         }
 389
 390         public String getRepositoryName() {
 391                 return repositoryName;
 392         }
 393
 394         public String getBranch() {
 395                 return branch;
 396         }
 397
 398         public boolean isTracked() {
 399                 return tracked;
 400         }
 401
 402         public boolean isIgnored() {
 403                 return ignored;
 404         }
 405
 406         public boolean isDirty() {
 407                 return dirty;
 408         }
 409
 410         public Staged staged() {
 411                 return staged;
 412         }
 413
 414         public boolean hasConflicts() {
 415                 return conflicts;
 416         }
 417
 418         public boolean isAssumeValid() {
 419                 return assumeValid;
 420         }
 421 }