Interface ISVNWCDb

  • All Known Implementing Classes:
    SVNWCDb

    public interface ISVNWCDb
    Working copy administrative database layer. The design doc mentions three different kinds of trees, BASE, WORKING and ACTUAL. We have different APIs to handle each tree, enumerated below, along with a blurb to explain what that tree represents.

    Has those next categories of routines:

    • General administractive functions
    • (*Base*") BASE tree management

      BASE should be what we get from the server. The *absolute* pristine copy. Nothing can change it -- it is always a reflection of the repository. You need to use checkout, update, switch, or commit to alter your view of the repository.

    • (*Pristine*) Pristine ("text base") management
    • (*Repository) Repository information management
    • (op*) Operations on WORKING tree
    • (read*) Read operations on the BASE/WORKING tree

      These functions query information about nodes in ACTUAL, and returns the requested information from the appropriate ACTUAL, WORKING, or BASE tree.

      For example, asking for the checksum of the pristine version will return the one recorded in WORKING, or if no WORKING node exists, then the checksum comes from BASE.

    • (global*) Operations that alter multiple trees
    • (*Lock) Function to manage the LOCKS table.
    • (scan*) Functions to scan up a tree for further data
    • (*WorkQueue) Work queue manipulation
    Author:
    TMate Software Ltd.
    • Method Detail

      • open

        void open​(ISVNWCDb.SVNWCDbOpenMode mode,
                  ISVNOptions config,
                  boolean autoUpgrade,
                  boolean enforceEmptyWQ)
        Open a working copy administrative database context.

        This context is (initially) not associated with any particular working copy directory or working copy root (wcroot). As operations are performed, this context will load the appropriate wcroot information.

        It should be closed manually using close(). In particular, this will close any SQLite databases that have been opened and cached.

        Parameters:
        mode - indicates whether the caller knows all interactions will be read-only, whether writing will definitely happen, or whether a default should be chosen.
        config - should hold the various configuration options that may apply to the administrative operation.
        autoUpgrade - when is true, then the working copy databases will be upgraded when possible (when an old database is found/detected during the operation of a ISVNWCDb API). If it is detected that a manual upgrade is required, then SVNErrorCode.WC_UPGRADE_REQUIRED will be thrown from that API. Passing false will allow a bare minimum of APIs to function (most notably, the getFormatTemp(File) function will always return a value) since most of these APIs expect a current-format database to be present.
        enforceEmptyWQ - if is true, then any databases with stale work items in their work queue will raise an error when they are opened. The operation will raise SVNErrorCode.WC_CLEANUP_REQUIRED. Passing false for this routine means that the work queue is being processed (via 'svn cleanup') and all operations should be allowed.
      • close

        void close()
        Close DB.
      • init

        void init​(java.io.File localAbsPath,
                  java.io.File reposRelPath,
                  SVNURL reposRootUrl,
                  java.lang.String reposUuid,
                  long initialRev,
                  SVNDepth depth,
                  int workingCopyFormat)
           throws SVNException
        Initialize the SqlDB for LOCAL_ABSPATH, which should be a working copy path.

        A REPOSITORY row will be constructed for the repository identified by REPOS_ROOT_URL and REPOS_UUID. Neither of these may be NULL.

        A node will be created for the directory at REPOS_RELPATH will be added. If INITIAL_REV is greater than zero, then the node will be marked as "incomplete" because we don't know its children. Contrary, if the INITIAL_REV is zero, then this directory should represent the root and we know it has no children, so the node is complete.

        DEPTH is the initial depth of the working copy, it must be a definite depth, not svn_depth_unknown.

        Throws:
        org.tmatesoft.sqljet.core.SqlJetException
        SVNException
      • toRelPath

        java.io.File toRelPath​(java.io.File localAbsPath)
                        throws SVNException
        Compute the LOCAL_RELPATH for the given LOCAL_ABSPATH.

        The LOCAL_RELPATH is a relative path to the working copy's root. That root will be located by this function, and the path will be relative to that location. If LOCAL_ABSPATH is the wcroot directory, then "" will be returned.

        The LOCAL_RELPATH should ONLY be used for persisting paths to disk. Those patsh should not be an abspath, otherwise the working copy cannot be moved. The working copy library should not make these paths visible in its API (which should all be abspaths), and it should not be using relpaths for other processing.

        note: with per-dir .svn directories, these relpaths will effectively be the basename. it gets interesting in single-db mode

        Throws:
        SVNException
      • toRelPath

        java.io.File toRelPath​(java.io.File wriAbsPath,
                               java.io.File localAbsPath)
                        throws SVNException
        Throws:
        SVNException
      • fromRelPath

        java.io.File fromRelPath​(java.io.File wcRootAbsPath,
                                 java.io.File localRelPath)
                          throws SVNException
        Compute the local abs path for a localRelPath located within the working copy identified by wcRootAbsPath.

        This is the reverse of toRelPath(File). It should be used for returning a persisted relpath back into an abspath.

        Throws:
        SVNException
      • addBaseDirectory

        void addBaseDirectory​(java.io.File localAbsPath,
                              java.io.File reposRelPath,
                              SVNURL reposRootUrl,
                              java.lang.String reposUuid,
                              long revision,
                              SVNProperties props,
                              long changedRev,
                              SVNDate changedDate,
                              java.lang.String changedAuthor,
                              java.util.List<java.io.File> children,
                              SVNDepth depth,
                              SVNProperties davCache,
                              SVNSkel conflict,
                              boolean updateActualProps,
                              SVNProperties actualProps,
                              java.util.Map<java.lang.String,​SVNProperties> iprops,
                              SVNSkel workItems)
                       throws SVNException
        Add or replace a directory in the BASE tree.

        The directory is located at LOCAL_ABSPATH on the local filesystem, and corresponds to in the repository, at revision REVISION.

        The directory properties are given by the PROPS.

        The last-change information is given by .

        The directory's children are listed in CHILDREN. The child nodes do NOT have to exist when this API is called. For each child node which does not exists, an "incomplete" node will be added. These child nodes will be added regardless of the DEPTH value. The caller must sort out which must be recorded, and which must be omitted.

        This subsystem does not use DEPTH, but it can be recorded here in the BASE tree for higher-level code to use.

        If CONFLICT is not NULL, then it describes a conflict for this node. The node will be record as conflicted (in ACTUAL).

        Any work items that are necessary as part of this node construction may be passed in WORK_ITEMS.

        Throws:
        SVNException
      • addBaseFile

        void addBaseFile​(java.io.File localAbspath,
                         java.io.File reposRelpath,
                         SVNURL reposRootUrl,
                         java.lang.String reposUuid,
                         long revision,
                         SVNProperties props,
                         long changedRev,
                         SVNDate changedDate,
                         java.lang.String changedAuthor,
                         SvnChecksum checksum,
                         SVNProperties davCache,
                         boolean deleteWorking,
                         boolean updateActualProps,
                         SVNProperties actualProps,
                         boolean keepRecordedInfo,
                         boolean insertBaseDeleted,
                         java.util.Map<java.lang.String,​SVNProperties> iprops,
                         SVNSkel conflict,
                         SVNSkel workItems)
                  throws SVNException
        Add or replace a file in the BASE tree.

        The file is located at LOCAL_ABSPATH on the local filesystem, and corresponds to in the repository, at revision REVISION.

        The file properties are given by the PROPS.

        The last-change information is given by .

        The checksum of the file contents is given in CHECKSUM. An entry in the pristine text base is NOT required when this API is called.

        If the translated size of the file (its contents, translated as defined by its properties) is known, then pass it as TRANSLATED_SIZE. Otherwise, pass INVALID_FILESIZE.

        If CONFLICT is not NULL, then it describes a conflict for this node. The node will be record as conflicted (in ACTUAL).

        Any work items that are necessary as part of this node construction may be passed in WORK_ITEMS.

        Parameters:
        svnProperties -
        Throws:
        SVNException
      • addBaseSymlink

        void addBaseSymlink​(java.io.File localAbsPath,
                            java.io.File reposRelPath,
                            SVNURL reposRootUrl,
                            java.lang.String reposUuid,
                            long revision,
                            SVNProperties props,
                            long changedRev,
                            SVNDate changedDate,
                            java.lang.String changedAuthor,
                            java.io.File target,
                            SVNProperties davCache,
                            SVNSkel conflict,
                            boolean updateActualProps,
                            SVNProperties acutalProps,
                            SVNSkel workItems)
                     throws SVNException
        Add or replace a symlink in the BASE tree.

        The symlink is located at LOCAL_ABSPATH on the local filesystem, and corresponds to in the repository, at revision REVISION.

        The symlink's properties are given by the PROPS.

        The last-change information is given by .

        The target of the symlink is specified by TARGET.

        If CONFLICT is not NULL, then it describes a conflict for this node. The node will be record as conflicted (in ACTUAL).

        Any work items that are necessary as part of this node construction may be passed in WORK_ITEMS.

        Throws:
        SVNException
      • addBaseExcludedNode

        void addBaseExcludedNode​(java.io.File localAbsPath,
                                 java.io.File reposRelPath,
                                 SVNURL reposRootUrl,
                                 java.lang.String reposUuid,
                                 long revision,
                                 ISVNWCDb.SVNWCDbKind kind,
                                 ISVNWCDb.SVNWCDbStatus status,
                                 SVNSkel conflict,
                                 SVNSkel workItems)
                          throws SVNException
        Create a node in the BASE tree that is present in name only.

        The new node will be located at LOCAL_ABSPATH, and correspond to the repository node described by at revision REVISION.

        The node's kind is described by KIND, and the reason for its absence is specified by STATUS. Only three values are allowed for STATUS:

        If CONFLICT is not NULL, then it describes a conflict for this node. The node will be record as conflicted (in ACTUAL).

        Any work items that are necessary as part of this node construction may be passed in WORK_ITEMS.

        Throws:
        SVNException
      • removeBase

        void removeBase​(java.io.File localAbsPath)
                 throws SVNException
        Remove a node from the BASE tree.

        The node to remove is indicated by LOCAL_ABSPATH from the local filesystem.

        Note that no changes are made to the local filesystem; LOCAL_ABSPATH is merely the key to figure out which BASE node to remove.

        If the node is a directory, then ALL child nodes will be removed from the BASE tree, too.

        Throws:
        SVNException
      • removeBase

        void removeBase​(java.io.File localAbsPath,
                        boolean keepAsWorking,
                        boolean queueDeletes,
                        boolean removeLocks,
                        long notPresentRevision,
                        SVNSkel conflict,
                        SVNSkel workItems)
                 throws SVNException
        Throws:
        SVNException
      • getBaseInfo

        ISVNWCDb.WCDbBaseInfo getBaseInfo​(java.io.File localAbsPath,
                                          ISVNWCDb.WCDbBaseInfo.BaseInfoField... fields)
                                   throws SVNException
        Retrieve information about a node in the BASE tree.

        For the BASE node implied by LOCAL_ABSPATH from the local filesystem, return information in the provided OUT parameters. Each OUT parameter may be NULL, indicating that specific item is not requested.

        If there is no information about this node, then SVNErrorCode.WC_PATH_NOT_FOUND will be thrown.

        The OUT parameters, and their "not available" values are:

        STATUS n/a (always available)
        KIND n/a (always available)
        REVISION -1
        REPOS_RELPATH NULL (caller should scan up)
        REPOS_ROOT_URL NULL (caller should scan up)
        REPOS_UUID NULL (caller should scan up)
        CHANGED_REV -1
        CHANGED_DATE 0
        CHANGED_AUTHOR NULL
        LAST_MOD_TIME 0
        DEPTH SVNDepth.UNKNOWN
        CHECKSUM NULL
        TRANSLATED_SIZE INVALID_FILESIZE
        TARGET NULL
        LOCK NULL

        If the STATUS is normal, and the REPOS_* values are NULL, then the caller should use scanBaseRepository(File, RepositoryInfoField...) to scan up the BASE tree for the repository information.

        If DEPTH is requested, and the node is NOT a directory, then the value will be set to svn_depth_unknown. If LOCAL_ABSPATH is a link, it's up to the caller to resolve depth for the link's target.

        If CHECKSUM is requested, and the node is NOT a file, then it will be set to NULL.

        If TRANSLATED_SIZE is requested, and the node is NOT a file, then it will be set to INVALID_FILESIZE.

        If TARGET is requested, and the node is NOT a symlink, then it will be set to NULL.

        Throws:
        SVNException
      • getBaseProps

        SVNProperties getBaseProps​(java.io.File localAbsPath)
                            throws SVNException
        Return the properties of the node LOCAL_ABSPATH in the BASE tree.

        If the node has no properties, return an empty hash. It will never return the NULL.
        If the node is not present in the BASE tree, throw an error.

        Throws:
        SVNException
      • getBaseChildren

        java.util.Set<java.lang.String> getBaseChildren​(java.io.File localAbsPath)
                                                 throws SVNException
        Return a list of the BASE tree node's children's names.

        For the node indicated by LOCAL_ABSPATH, this function will return the names of all of its children in the list CHILDREN.

        If the node is not a directory, then SVNErrorCode.WC_NOT_WORKING_COPY will be thrown.

        Throws:
        SVNException
      • clearDavCacheRecursive

        void clearDavCacheRecursive​(java.io.File localAbsPath)
                             throws SVNException
        Throws:
        SVNException
      • getPristinePath

        java.io.File getPristinePath​(java.io.File wcRootAbsPath,
                                     SvnChecksum checksum)
                              throws SVNException
        Get the path to the pristine text file identified by SHA1_CHECKSUM. Error if it does not exist.

        ### This is temporary - callers should not be looking at the file directly.

        Throws:
        SVNException
      • readPristine

        java.io.InputStream readPristine​(java.io.File wcRootAbsPath,
                                         SvnChecksum checksum)
                                  throws SVNException
        Get a readable stream that will yield the pristine text identified by CHECKSUM (### which should/must be its SHA-1 checksum?).
        Throws:
        SVNException
      • getPristineTempDir

        java.io.File getPristineTempDir​(java.io.File wcRootAbsPath)
                                 throws SVNException
        Get a directory in which the caller should create a uniquely named file for later installation as a pristine text file.

        The directory is guaranteed to be one that installPristine(File, SvnChecksum, SvnChecksum) can use: specifically, one from which it can atomically move the file.

        Throws:
        SVNException
      • installPristine

        void installPristine​(java.io.File tempfileAbspath,
                             SvnChecksum sha1Checksum,
                             SvnChecksum md5Checksum)
                      throws SVNException
        Install the file TEMPFILE_ABSPATH (which is sitting in a directory given by getPristineTempDir(File)) into the pristine data store, to be identified by the SHA-1 checksum of its contents, SHA1_CHECKSUM.

        ### the md5_checksum parameter is temporary.

        Throws:
        SVNException
      • getPristineMD5

        SvnChecksum getPristineMD5​(java.io.File wcRootAbsPath,
                                   SvnChecksum sha1Checksum)
                            throws SVNException
        Get the MD-5 checksum of a pristine text identified by its SHA-1 checksum SHA1_CHECKSUM. Return an error if the pristine text does not exist or its MD5 checksum is not found.
        Throws:
        SVNException
      • getPristineSHA1

        SvnChecksum getPristineSHA1​(java.io.File wcRootAbsPath,
                                    SvnChecksum md5Checksum)
                             throws SVNException
        Get the SHA-1 checksum of a pristine text identified by its MD-5 checksum MD5_CHECKSUM. Return an error if the pristine text does not exist or its SHA-1 checksum is not found.

        Note: The MD-5 checksum is not strictly guaranteed to be unique in the database table, although duplicates are expected to be extremely rare.

        ### TODO: The behaviour is currently unspecified if the MD-5 checksum is not unique. Need to see whether this function is going to stay in use, and, if so, address this somehow.

        Throws:
        SVNException
      • removePristine

        void removePristine​(java.io.File wcRootAbsPath,
                            SvnChecksum checksum)
                     throws SVNException
        Remove the pristine text with SHA-1 checksum SHA1_CHECKSUM from the pristine store, if it is not referenced by any of the (other) WC DB tables.
        Throws:
        SVNException
      • cleanupPristine

        void cleanupPristine​(java.io.File wcRootAbsPath)
                      throws SVNException
        Remove all unreferenced pristines belonging to WRI_ABSPATH in DB.
        Throws:
        SVNException
      • checkPristine

        boolean checkPristine​(java.io.File wcRootAbsPath,
                              SvnChecksum checksum)
                       throws SVNException
        Check for presence, according to the given mode (on how hard we should examine things)
        Throws:
        SVNException
      • opCopy

        void opCopy​(java.io.File srcAbsPath,
                    java.io.File dstAbsPath,
                    java.io.File dstOpRootAbsPath,
                    boolean isMove,
                    SVNSkel workItems)
             throws SVNException
        svn cp WCPATH WCPATH ... can copy mixed base/working around
        Throws:
        SVNException
      • opCopyShadowedLayer

        void opCopyShadowedLayer​(java.io.File srcAbsPath,
                                 java.io.File dstAbsPath,
                                 boolean isMove)
                          throws SVNException
        Throws:
        SVNException
      • opCopyDir

        void opCopyDir​(java.io.File localAbsPath,
                       SVNProperties props,
                       long changedRev,
                       SVNDate changedDate,
                       java.lang.String changedAuthor,
                       java.io.File originalReposRelPath,
                       SVNURL originalRootUrl,
                       java.lang.String originalUuid,
                       long originalRevision,
                       java.util.List<java.io.File> children,
                       boolean isMove,
                       SVNDepth depth,
                       SVNSkel conflict,
                       SVNSkel workItems)
                throws SVNException
        Record a copy at LOCAL_ABSPATH from a repository directory.

        This copy is NOT recursive. It simply establishes this one node. CHILDREN must be provided, and incomplete nodes will be constructed for them.

        Throws:
        SVNException
      • opCopyFile

        void opCopyFile​(java.io.File localAbsPath,
                        SVNProperties props,
                        long changedRev,
                        SVNDate changedDate,
                        java.lang.String changedAuthor,
                        java.io.File originalReposRelPath,
                        SVNURL originalRootUrl,
                        java.lang.String originalUuid,
                        long originalRevision,
                        SvnChecksum checksum,
                        boolean updateActualProps,
                        SVNProperties newActualProps,
                        SVNSkel conflict,
                        SVNSkel workItems)
                 throws SVNException
        Record a copy at LOCAL_ABSPATH from a repository file.
        Throws:
        SVNException
      • opAddDirectory

        void opAddDirectory​(java.io.File localAbsPath,
                            SVNProperties props,
                            SVNSkel workItems)
                     throws SVNException
        Add a new versioned directory. A list of children is NOT passed since they are added in future, distinct calls to opAddDirectory(). Tthis is freshly added, so it has no properties.
        Throws:
        SVNException
      • opAddFile

        void opAddFile​(java.io.File localAbsPath,
                       SVNProperties props,
                       SVNSkel workItems)
                throws SVNException
        As a new file, there are no properties. This file has no "pristine" contents, so a checksum [reference] is not required.
        Throws:
        SVNException
      • opSetProps

        void opSetProps​(java.io.File localAbsPath,
                        SVNProperties props,
                        SVNSkel conflict,
                        boolean clearRecordedInfo,
                        SVNSkel workItems)
                 throws SVNException
        Set the properties of the node LOCAL_ABSPATH in the ACTUAL tree to PROPS.

        To specify no properties, PROPS must be an empty hash, not NULL. If the node is not present, throw an error.

        CONFLICT is used to register a conflict on this node at the same time the properties are changed.

        WORK_ITEMS are inserted into the work queue, as additional things that need to be completed before the working copy is stable.

        NOTE: This will overwrite ALL working properties the node currently has. There is no opSetProp() function. Callers must read all the properties, change one, and write all the properties.

        NOTE: This will create an entry in the ACTUAL table for the node if it does not yet have one.

        Throws:
        SVNException
      • opSetChangelist

        void opSetChangelist​(java.io.File localAbsPath,
                             java.lang.String changelistName,
                             java.lang.String[] changeLists,
                             SVNDepth depth,
                             ISVNEventHandler handler)
                      throws SVNException
        use NULL to remove from a changelist.
        Throws:
        SVNException
      • opMarkResolved

        void opMarkResolved​(java.io.File localAbspath,
                            boolean resolvedText,
                            boolean resolvedProps,
                            boolean resolvedTree,
                            SVNSkel workItems)
                     throws SVNException
        caller maintains ACTUAL, and how the resolution occurred. we're just recording state.

        I'm not sure that these three values are the best way to do this, but they're handy for now.

        Throws:
        SVNException
      • opReadAllTreeConflicts

        java.util.Map<java.lang.String,​SVNTreeConflictDescription> opReadAllTreeConflicts​(java.io.File localAbsPath)
                                                                                         throws SVNException
        Return all the children of localAbsPath that are in tree conflicts.
        Throws:
        SVNException
      • opSetTreeConflict

        void opSetTreeConflict​(java.io.File localAbspath,
                               SVNTreeConflictDescription treeConflict)
                        throws SVNException
        Set the tree conflict on LOCAL_ABSPATH in DB to TREE_CONFLICT. Use NULL to remove a tree conflict.
        Throws:
        SVNException
      • readInfo

        ISVNWCDb.WCDbInfo readInfo​(java.io.File localAbsPath,
                                   ISVNWCDb.WCDbInfo.InfoField... fields)
                            throws SVNException
        Retrieve information about a node.

        For the node implied by LOCAL_ABSPATH from the local filesystem, return information in the provided OUT parameters. Each OUT parameter may be NULL, indicating that specific item is not requested.

        The information returned comes from the BASE tree, as possibly modified by the WORKING and ACTUAL trees.

        If there is no information about the node, then SVNErrorCode.WC_PATH_NOT_FOUND will be returned.

        The OUT parameters, and their "not available" values are:

        STATUS n/a (always available)
        KIND n/a (always available)
        REVISION SVN_INVALID_REVNUM
        REPOS_RELPATH NULL
        REPOS_ROOT_URL NULL
        REPOS_UUID NULL
        CHANGED_REV SVN_INVALID_REVNUM
        CHANGED_DATE 0
        CHANGED_AUTHOR NULL
        LAST_MOD_TIME 0
        DEPTH svn_depth_unknown
        CHECKSUM NULL
        TRANSLATED_SIZE SVN_INVALID_FILESIZE
        TARGET NULL
        CHANGELIST NULL
        ORIGINAL_REPOS_RELPATH NULL
        ORIGINAL_ROOT_URL NULL
        ORIGINAL_UUID NULL
        ORIGINAL_REVISION SVN_INVALID_REVNUM
        TEXT_MOD n/a (always available)
        PROPS_MOD n/a (always available)
        BASE_SHADOWED n/a (always available)
        CONFLICTED FALSE
        LOCK NULL

        When STATUS is requested, then it will be one of these values:

        • ISVNWCDb.SVNWCDbStatus.Normal

          A plain BASE node, with no local changes.

        • ISVNWCDb.SVNWCDbStatus.Added
          ISVNWCDb.SVNWCDbStatus.ObstructedAdd

          A node has been added/copied/moved to here. See BASE_SHADOWED to see if this change overwrites a BASE node. Use scan_addition() to resolve whether this has been added, copied, or moved, and the details of the operation (this function only looks at LOCAL_ABSPATH, but resolving the details requires scanning one or more ancestor nodes).

        • ISVNWCDb.SVNWCDbStatus.Deleted
          ISVNWCDb.SVNWCDbStatus.ObstructedDelete

          This node has been deleted or moved away. It may be a delete/move of a BASE node, or a child node of a subtree that was copied/moved to an ancestor location. Call scan_deletion() to determine the full details of the operations upon this node.

        • ISVNWCDb.SVNWCDbStatus.Obstructed

          The versioned subdirectory is missing or obstructed by a file.

        • SVNWCDbStatus#Absent

          The node is versioned/known by the server, but the server has decided not to provide further information about the node. This is a BASE node (since changes are not allowed to this node).

        • ISVNWCDb.SVNWCDbStatus.Excluded

          The node has been excluded from the working copy tree. This may be an exclusion from the BASE tree, or an exclusion for a child node of a copy/move to an ancestor (see BASE_SHADOWED to determine the situation).

        • SVNWCDbStatus#notPresent

          This is a node from the BASE tree, has been marked as "not-present" within this mixed-revision working copy. This node is at a revision that is not in the tree, contrary to its inclusion in the parent node's revision.

        • ISVNWCDb.SVNWCDbStatus.Incomplete

          The BASE or WORKING node is incomplete due to an interrupted operation.

        If REVISION is requested, it will be set to the revision of the unmodified (BASE) node, or to -1 if any structural changes have been made to that node (that is, if the node has a row in the WORKING table).

        If DEPTH is requested, and the node is NOT a directory, then the value will be set to SVNDepth.UNKNOWN.

        If CHECKSUM is requested, and the node is NOT a file, then it will be set to NULL.

        If TRANSLATED_SIZE is requested, and the node is NOT a file, then it will be set to INVALID_FILESIZE.

        If TARGET is requested, and the node is NOT a symlink, then it will be set to NULL.

        Throws:
        SVNException
        • readProperties

          SVNProperties readProperties​(java.io.File localAbsPath)
                                throws SVNException
          Return the properties of the node LOCAL_ABSPATH in the ACTUAL tree (looking through to the WORKING or BASE tree as required).

          If the node has no properties, return an empty hash.

          If the node is not present, throw an error.

          Throws:
          SVNException
        • readPristineProperties

          SVNProperties readPristineProperties​(java.io.File localAbspath)
                                        throws SVNException
          Return the properties of the node LOCAL_ABSPATH in the WORKING tree (looking through to the BASE tree as required).

          If the node has no properties, return an empty hash.

          If the node is not present, throw an error.

          Throws:
          SVNException
        • readChildren

          java.util.Set<java.lang.String> readChildren​(java.io.File localAbspath)
                                                throws SVNException
          Return the basenames of the immediate children of LOCAL_ABSPATH in DB.
          Throws:
          SVNException
        • readConflictVictims

          java.util.List<java.lang.String> readConflictVictims​(java.io.File localAbspath)
                                                        throws SVNException
          Return the basenames of the immediate children of LOCAL_ABSPATH in DB that are conflicted.

          In case of tree conflicts a victim doesn't have to be in the working copy.

          This function will probably be removed.

          Throws:
          SVNException
        • readConflicts

          java.util.List<SVNConflictDescription> readConflicts​(java.io.File localAbsPath)
                                                        throws SVNException
          Return all conflicts that have LOCAL_ABSPATH as victim.

          Victim must be versioned or be part of a tree conflict.

          Currently there can be just one property conflict recorded per victim

          This function will probably be removed.

          Throws:
          SVNException
        • readKind

          ISVNWCDb.SVNWCDbKind readKind​(java.io.File localAbsPath,
                                        boolean allowMissing)
                                 throws SVNException
          Return the kind of the node in DB at LOCAL_ABSPATH. The WORKING tree will be examined first, then the BASE tree. If the node is not present in either tree and ALLOW_MISSING is TRUE, then SVNWCDbKind#unknown is returned. If the node is missing and ALLOW_MISSING is FALSE, then it will throw SVNErrorCode.WC_PATH_NOT_FOUND.
          Throws:
          SVNException
        • isNodeHidden

          boolean isNodeHidden​(java.io.File localAbsPath)
                        throws SVNException
          Return TRUE if LOCAL_ABSPATH in DB "is not present, and I haven't scheduled something over the top of it."
          Throws:
          SVNException
        • globalCommit

          void globalCommit​(java.io.File localAbspath,
                            long newRevision,
                            long changedRevision,
                            SVNDate changedDate,
                            java.lang.String changedAuthor,
                            SvnChecksum newChecksum,
                            java.util.List<java.io.File> newChildren,
                            SVNProperties newDavCache,
                            boolean keepChangelist,
                            boolean noUnlock,
                            SVNSkel workItems)
                     throws SVNException
          Collapse the WORKING and ACTUAL tree changes down into BASE, called for each committed node.

          NEW_REVISION must be the revision number of the revision created by the commit. It will become the BASE node's 'revnum' and 'changed_rev' values in the BASE_NODE table.

          NEW_DATE is the (server-side) date of the new revision. It may be 0 if the revprop is missing on the revision.

          NEW_AUTHOR is the (server-side) author of the new revision. It may be NULL if the revprop is missing on the revision.

          One or both of NEW_CHECKSUM and NEW_CHILDREN should be NULL. For new:

          • files: NEW_CHILDREN should be NULL
          • dirs: NEW_CHECKSUM should be NULL
          • symlinks: both should be NULL

          WORK_ITEMS will be place into the work queue.

          Throws:
          SVNException
        • globalRecordFileinfo

          void globalRecordFileinfo​(java.io.File local_abspath,
                                    long translated_size,
                                    long last_mod_time)
                             throws SVNException
          Record the TRANSLATED_SIZE and LAST_MOD_TIME for a versioned node.

          This function will record the information within the WORKING node, if present, or within the BASE tree. If neither node is present, then SVNErrorCode.WC_PATH_NOT_FOUND will be thrown.

          TRANSLATED_SIZE may be INVALID_FILESIZE, which will be recorded as such, implying "unknown size".

          LAST_MOD_TIME may be 0, which will be recorded as such, implying "unknown last mod time".

          Throws:
          SVNException
        • removeLock

          void removeLock​(java.io.File localAbsPath)
                   throws SVNException
          Remove any lock for LOCAL_ABSPATH in DB.
          Throws:
          SVNException
        • scanBaseRepository

          ISVNWCDb.WCDbRepositoryInfo scanBaseRepository​(java.io.File localAbsPath,
                                                         ISVNWCDb.WCDbRepositoryInfo.RepositoryInfoField... fields)
                                                  throws SVNException
          Scan for a BASE node's repository information.

          In the typical case, a BASE node has unspecified repository information, meaning that it is implied by its parent's information. When the info is needed, this function can be used to scan up the BASE tree to find the data.

          For the BASE node implied by LOCAL_ABSPATH, its location in the repository returned in REPOS_ROOT_URL and REPOS_UUID will be returned in REPOS_RELPATH. Any of the OUT parameters may be NULL, indicating no interest in that piece of information.

          Throws:
          SVNException
        • scanAddition

          ISVNWCDb.WCDbAdditionInfo scanAddition​(java.io.File localAbsPath,
                                                 ISVNWCDb.WCDbAdditionInfo.AdditionInfoField... fields)
                                          throws SVNException
          Scan upwards for information about a known addition to the WORKING tree.

          If a node's status as returned by readInfo(File, InfoField...) is ISVNWCDb.SVNWCDbStatus.Added (NOT obstructed_add!), then this function returns a refined status in STATUS, which is one of:

          • ISVNWCDb.SVNWCDbStatus.Added -- this NODE is a simple add without history. OP_ROOT_ABSPATH will be set to the topmost node in the added subtree (implying its parent will be an unshadowed BASE node). The REPOS_* values will be implied by that ancestor BASE node and this node's position in the added subtree. ORIGINAL_* will be set to their NULL values (and SVN_INVALID_REVNUM for ORIGINAL_REVISION).
          • ISVNWCDb.SVNWCDbStatus.Copied -- this NODE is the root or child of a copy. The root of the copy will be stored in OP_ROOT_ABSPATH. Note that the parent of the operation root could be another WORKING node (from an add, copy, or move). The REPOS_* values will be implied by the ancestor unshadowed BASE node. ORIGINAL_* will indicate the source of the copy.
          • ISVNWCDb.SVNWCDbStatus.MovedHere -- this NODE arrived as a result of a move. The root of the moved nodes will be stored in OP_ROOT_ABSPATH. Similar to the copied state, its parent may be a WORKING node or a BASE node. And again, the REPOS_* values are implied by this node's position in the subtree under the ancestor unshadowed BASE node. ORIGINAL_* will indicate the source of the move.

          All OUT parameters may be NULL to indicate a lack of interest in that piece of information.

          STATUS, OP_ROOT_ABSPATH, and REPOS_* will always be assigned a value if that information is requested (and assuming a successful return).

          ORIGINAL_REPOS_RELPATH will refer to the root of the operation. It does not correspond to the node given by LOCAL_ABSPATH. The caller can use the suffix on LOCAL_ABSPATH (relative to OP_ROOT_ABSPATH) in order to compute the source node which corresponds to LOCAL_ABSPATH.

          If the node given by LOCAL_ABSPATH does not have changes recorded in the WORKING tree, then SVNErrorCode.WC_PATH_NOT_FOUND is thrown. If it doesn't have an "added" status, then SVNErrorCode.WC_PATH_UNEXPECTED_STATUS will be thrown.

          Throws:
          SVNException
        • scanDeletion

          ISVNWCDb.WCDbDeletionInfo scanDeletion​(java.io.File localAbsPath,
                                                 ISVNWCDb.WCDbDeletionInfo.DeletionInfoField... fields)
                                          throws SVNException
          Scan upwards for additional information about a deleted node.

          When a deleted node is discovered in the WORKING tree, the situation may be quite complex. This function will provide the information to resolve the circumstances of the deletion.

          For discussion purposes, we will start with the most complex example and then demonstrate simplified examples. Consider node B/W/D/N has been found as deleted. B is an unmodified directory (thus, only in BASE). W is "replacement" content that exists in WORKING, shadowing a similar B/W directory in BASE. D is a deleted subtree in the WORKING tree, and N is the deleted node.

          In this example, BASE_DEL_ABSPATH will bet set to B/W. That is the root of the BASE tree (implicitly) deleted by the replacement. BASE_REPLACED will be set to TRUE since B/W replaces the BASE node at B/W. WORK_DEL_ABSPATH will be set to the subtree deleted within the replacement; in this case, B/W/D. No move-away took place, so MOVED_TO_ABSPATH is set to NULL.

          In another scenario, B/W was moved-away before W was put into the WORKING tree through an add/copy/move-here. MOVED_TO_ABSPATH will indicate where B/W was moved to. Note that further operations may have been performed post-move, but that is not known or reported by this function.

          If BASE does not have a B/W, then the WORKING B/W is not a replacement, but a simple add/copy/move-here. BASE_DEL_ABSPATH will be set to NULL, and BASE_REPLACED will be set to FALSE.

          If B/W/D does not exist in the WORKING tree (we're only talking about a deletion of nodes of the BASE tree), then deleting B/W/D would have marked the subtree for deletion. BASE_DEL_ABSPATH will refer to B/W/D, BASE_REPLACED will be FALSE, MOVED_TO_ABSPATH will be NULL, and WORK_DEL_ABSPATH will be NULL.

          If the BASE node B/W/D was moved instead of deleted, then MOVED_TO_ABSPATH would indicate the target location (and other OUT values as above).

          When the user deletes B/W/D from the WORKING tree, there are a few additional considerations. If B/W is a simple addition (not a copy or a move-here), then the deletion will simply remove the nodes from WORKING and possibly leave behind "base-delete" markers in the WORKING tree. If the source is a copy/moved-here, then the nodes are replaced with deletion markers.

          If the user moves-away B/W/D from the WORKING tree, then behavior is again dependent upon the origination of B/W. For a plain add, the nodes simply move to the destination. For a copy, a deletion is made at B/W/D, and a new copy (of a subtree of the original source) is made at the destination. For a move-here, a deletion is made, and a copy is made at the destination (we do not track multiple moves; the source is moved to B/W, then B/W/D is deleted; then a copy is made at the destination; however, note the double-move could have been performed by moving the subtree first, then moving the source to B/W).

          There are three further considerations when resolving a deleted node:

          • If the BASE B/W/D was moved-away, then BASE_DEL_ABSPATH will specify B/W/D as the root of the BASE deletion (not necessarily B/W as an implicit delete caused by a replacement; only the closest ancestor is reported). The other parameters will operate as normal, based on what is happening in the WORKING tree. Also note that ancestors of B/W/D may report additional, explicit moved-away status.
          • If the BASE B/W/D was deleted explicitly *and* B/W is a replacement, then the explicit deletion is subsumed by the implicit deletion that occurred with the B/W replacement. Thus, BASE_DEL_ABSPATH will point to B/W as the root of the BASE deletion. IOW, we can detect the explicit move-away, but not an explicit deletion.
          • If B/W/D/N refers to a node present in the BASE tree, and B/W was replaced by a shallow subtree, then it is possible for N to be reported as deleted (from BASE) yet no deletions occurred in the WORKING tree above N. Thus, WORK_DEL_ABSPATH will be set to NULL.

          Summary of OUT parameters:

          • BASE_DEL_ABSPATH will specify the nearest ancestor of the explicit or implicit deletion (if any) that applies to the BASE tree.
          • BASE_REPLACED will specify whether the node at BASE_DEL_ABSPATH has been replaced (shadowed) by nodes in the WORKING tree. If no BASE deletion has occurred (BASE_DEL_ABSPATH is NULL, meaning the deletion is confined to the WORKING TREE), then BASE_REPLACED will be FALSE.
          • MOVED_TO_ABSPATH will specify the nearest ancestor that has moved-away, if any. If no ancestors have been moved-away, then this is set to NULL.
          • WORK_DEL_ABSPATH will specify the root of a deleted subtree within the WORKING tree (note there is no concept of layered delete operations in WORKING, so there is only one deletion root in the ancestry).

          All OUT parameters may be set to NULL to indicate a lack of interest in that piece of information.

          If the node given by LOCAL_ABSPATH does not exist, then SVNErrorCode.WC_PATH_NOT_FOUND is returned. If it doesn't have a "deleted" status, then SVNErrorCode.WC_PATH_UNEXPECTED_STATUS will be returned.

          Throws:
          SVNException
        • addWorkQueue

          void addWorkQueue​(java.io.File wcRootAbsPath,
                            SVNSkel workItem)
                     throws SVNException
          In the WCROOT associated with DB and WRI_ABSPATH, add WORK_ITEM to the wcroot's work queue.
          Throws:
          SVNException
        • fetchWorkQueue

          ISVNWCDb.WCDbWorkQueueInfo fetchWorkQueue​(java.io.File wcRootAbsPath)
                                             throws SVNException
          In the WCROOT associated with DB and WRI_ABSPATH, fetch a work item that needs to be completed. Its identifier is returned in ID, and the data in WORK_ITEM.

          Items are returned in the same order they were queued. This allows for (say) queueing work on a parent node to be handled before that of its children.

          If there are no work items to be completed, then ID will be set to zero, and WORK_ITEM to NULL.

          Throws:
          SVNException
        • completedWorkQueue

          void completedWorkQueue​(java.io.File wcRootAbsPath,
                                  long id)
                           throws SVNException
          In the WCROOT associated with DB and WRI_ABSPATH, mark work item ID as completed. If an error occurs, then it is unknown whether the work item has been marked as completed.
          Throws:
          SVNException
        • isWCRoot

          boolean isWCRoot​(java.io.File localAbspath,
                           boolean isAdditionMode)
                    throws SVNException
          Throws:
          SVNException
        • getFormatTemp

          int getFormatTemp​(java.io.File localDirAbsPath)
                     throws SVNException
          temp function. return the FORMAT for the directory LOCAL_ABSPATH.
          Throws:
          SVNException
        • getFileExternalTemp

          java.lang.String getFileExternalTemp​(java.io.File path)
                                        throws SVNException
          Return the serialized file external info (from BASE) for LOCAL_ABSPATH. Stores NULL into SERIALIZED_FILE_EXTERNAL if this node is NOT a file external. If a BASE node does not exist: SVN_ERR_WC_PATH_NOT_FOUND.
          Throws:
          SVNException
        • opStartDirectoryUpdateTemp

          void opStartDirectoryUpdateTemp​(java.io.File localAbspath,
                                          java.io.File newRelpath,
                                          long targetRevision)
                                   throws SVNException
          Throws:
          SVNException
        • opMakeCopyTemp

          void opMakeCopyTemp​(java.io.File localAbspath,
                              boolean removeBase)
                       throws SVNException
          Throws:
          SVNException
        • opSetNewDirToIncompleteTemp

          void opSetNewDirToIncompleteTemp​(java.io.File localAbspath,
                                           java.io.File reposRelpath,
                                           SVNURL reposRootURL,
                                           java.lang.String reposUuid,
                                           long revision,
                                           SVNDepth depth,
                                           boolean insertBaseDeleted,
                                           boolean deleteWorking,
                                           SVNSkel conflict,
                                           SVNSkel workItems)
                                    throws SVNException
          Throws:
          SVNException
        • getWCRootTempDir

          java.io.File getWCRootTempDir​(java.io.File localAbspath)
                                 throws SVNException
          Throws:
          SVNException
        • opSetBaseIncompleteTemp

          void opSetBaseIncompleteTemp​(java.io.File localDirAbspath,
                                       boolean incomplete)
                                throws SVNException
          Throws:
          SVNException
        • opSetRevAndReposRelpathTemp

          void opSetRevAndReposRelpathTemp​(java.io.File localAbspath,
                                           long newRevision,
                                           boolean setReposRelpath,
                                           java.io.File newReposRelpath,
                                           SVNURL reposRootUrl,
                                           java.lang.String reposUuid)
                                    throws SVNException
          Throws:
          SVNException
        • obtainWCLock

          void obtainWCLock​(java.io.File localAbspath,
                            int i,
                            boolean b)
                     throws SVNException
          Throws:
          SVNException
        • isWCLockOwns

          boolean isWCLockOwns​(java.io.File localAbspath,
                               boolean exact)
                        throws SVNException
          Throws:
          SVNException
        • opSetTextConflictMarkerFilesTemp

          void opSetTextConflictMarkerFilesTemp​(java.io.File localAbspath,
                                                java.io.File oldBasename,
                                                java.io.File newBasename,
                                                java.io.File wrkBasename)
                                         throws SVNException
          Throws:
          SVNException
        • opSetPropertyConflictMarkerFileTemp

          void opSetPropertyConflictMarkerFileTemp​(java.io.File localAbspath,
                                                   java.lang.String prejBasename)
                                            throws SVNException
          Throws:
          SVNException
        • opBumpRevisionPostUpdate

          void opBumpRevisionPostUpdate​(java.io.File localAbsPath,
                                        SVNDepth depth,
                                        java.io.File newReposRelPath,
                                        SVNURL newReposRootURL,
                                        java.lang.String newReposUUID,
                                        long newRevision,
                                        java.util.Collection<java.io.File> excludedPaths,
                                        java.util.Map<java.io.File,​java.util.Map<java.lang.String,​SVNProperties>> inheritableProperties,
                                        ISVNEventHandler eventHandler)
                                 throws SVNException
          Throws:
          SVNException
        • getExternalsDefinedBelow

          java.util.Map<java.io.File,​java.io.File> getExternalsDefinedBelow​(java.io.File localAbsPath)
                                                                           throws SVNException
          Throws:
          SVNException
        • registerExternal

          void registerExternal​(java.io.File definingAbsPath,
                                java.io.File localAbsPath,
                                SVNNodeKind kind,
                                SVNURL reposRootUrl,
                                java.lang.String reposUuid,
                                java.io.File reposRelPath,
                                long operationalRevision,
                                long revision)
                         throws SVNException
          Throws:
          SVNException
        • getChildrenOfWorkingNode

          java.util.Set<java.lang.String> getChildrenOfWorkingNode​(java.io.File dirAbsPath)
                                                            throws SVNException
          Throws:
          SVNException
        • getConflictMarkerFiles

          java.util.List<java.io.File> getConflictMarkerFiles​(java.io.File localAbsPath)
                                                       throws SVNException
          Throws:
          SVNException
        • minMaxRevisions

          long[] minMaxRevisions​(java.io.File localAbsPath,
                                 boolean committed)
                          throws SVNException
          Throws:
          SVNException
        • opHandleMoveBack

          boolean opHandleMoveBack​(java.io.File localAbsPath,
                                   java.io.File movedFromAbsPath,
                                   SVNSkel workItems)
                            throws SVNException
          Throws:
          SVNException
        • requiredLockForResolve

          java.io.File requiredLockForResolve​(java.io.File localAbsPath)
                                       throws SVNException
          Throws:
          SVNException
        • getNodeLockTokensRecursive

          java.util.Map<SVNURL,​java.lang.String> getNodeLockTokensRecursive​(java.io.File localAbsPath)
                                                                           throws SVNException
          Throws:
          SVNException
        • upgradeInsertExternal

          void upgradeInsertExternal​(java.io.File localAbsPath,
                                     SVNNodeKind kind,
                                     java.io.File parentAbsPath,
                                     java.io.File defLocalAbsPath,
                                     java.io.File reposRelPath,
                                     SVNURL reposRootUrl,
                                     java.lang.String reposUuid,
                                     long defPegRevision,
                                     long defRevision)
                              throws SVNException
          Throws:
          SVNException