"

 Copyright (c) 2007-2010 Jan Vrany

 Copyright (c) 2009-2010 eXept Software AG

 Permission is hereby granted, free of charge, to any person

 obtaining a copy of this software and associated documentation

 files (the 'Software'), to deal in the Software without

 restriction, including without limitation the rights to use,

 copy, modify, merge, publish, distribute, sublicense, and/or sell

 copies of the Software, and to permit persons to whom the

 Software is furnished to do so, subject to the following

 conditions:

 The above copyright notice and this permission notice shall be

 included in all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,

 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

 OTHER DEALINGS IN THE SOFTWARE.

"

"{ Package: 'stx:libsvn' }"

AbstractSourceCodeManager subclass:#SVNSourceCodeManager

	instanceVariableNames:''

	classVariableNames:'LoadInProgressQuery'

	poolDictionaries:''

	category:'System-SourceCodeManagement'

!

SourceCodeManagerUtilities subclass:#Utilities

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:SVNSourceCodeManager

!

!SVNSourceCodeManager class methodsFor:'documentation'!

copyright

"

 Copyright (c) 2007-2010 Jan Vrany

 Copyright (c) 2009-2010 eXept Software AG

 Permission is hereby granted, free of charge, to any person

 obtaining a copy of this software and associated documentation

 files (the 'Software'), to deal in the Software without

 restriction, including without limitation the rights to use,

 copy, modify, merge, publish, distribute, sublicense, and/or sell

 copies of the Software, and to permit persons to whom the

 Software is furnished to do so, subject to the following

 conditions:

 The above copyright notice and this permission notice shall be

 included in all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,

 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

 OTHER DEALINGS IN THE SOFTWARE.

"

!

documentation

"

    For now, this is a dummy SourceCodeManager.

    It is only provided to deliver the correct versionMethodNameTemplates

    and versionMethod names.

    Might get more in the future.

"

! !

!SVNSourceCodeManager class methodsFor:'* As yet uncategorized *'!

checkin:filename text:contents directory:directory module:module logMessage: message force: force

    | branch wc status |

    self shouldImplement.

    branch := self branchForModule: module directory: directory.

    wc := branch repository workingCopy.

    wc ensureIsValid.

    (wc path / filename) writingFileDo:[:s|s nextPutAll: contents].

    status := wc status: { filename }.

    "Created: / 27-11-2011 / 22:51:39 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

removeContainer:container inModule:module directory:directory

    | repo wc |

    repo := self repositoryForModule: module directory: directory.

    repo isNil ifTrue:[

        self error:'No SVN repository'.

        ^self

    ].

    wc := repo workingCopy.

    wc delete: container

    "Created: / 23-12-2011 / 18:20:05 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!SVNSourceCodeManager class methodsFor:'Signal constants'!

loadInProgressQuery

    LoadInProgressQuery ifNil:

        [LoadInProgressQuery := QuerySignal new].

    ^LoadInProgressQuery

! !

!SVNSourceCodeManager class methodsFor:'accessing'!

repositoryNameForPackage:packageId 

    "superclass AbstractSourceCodeManager class says that I am responsible to implement this method"

    |repo|

    repo := SVN::RepositoryManager current repositoryForPackage:packageId.

    repo isNil ifTrue:[

        ^ 'N/A'

    ] ifFalse:[

        ^ repo url asString

    ]

    "Modified: / 10-10-2011 / 19:49:52 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

shownInBrowserMenus

    "can be redefined in subclasses which can be suppressed in the browser's menus"

    ^ UserPreferences current svnEnabled

    "Created: / 08-01-2012 / 19:56:22 / cg"

    "Created: / 19-01-2012 / 13:11:03 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

shownInBrowserMenus:aBoolean

    "can be redefined in subclasses which can be suppressed in the browser's menus"

    ^ UserPreferences current svnEnabled: aBoolean

    "Created: / 19-01-2012 / 13:11:19 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

utilities

    ^Utilities forManager: self.

    "Created: / 11-10-2011 / 11:24:04 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!SVNSourceCodeManager class methodsFor:'basic access'!

checkinClass:aClass fileName:classFileName directory:packageDir module:moduleDir source:sourceFile logMessage:logMessage force:force

    "checkin of a class into the source repository.

     Return true if ok, false if not."

    | repo |

    repo := SVN::RepositoryManager repositoryForModule: moduleDir directory: packageDir.

    repo ifNil:[^false].

    self shouldImplement: 'Not yet finished'.

    ^false

    "Modified: / 12-10-2011 / 18:50:55 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

checkoutModule:aModule directory:aPackage andDo:aBlock

    "check out everything from a package into a temporary directory.

     Then evaluate aBlock, passing the name of that temp-directory.

     Afterwards, the tempDir is removed.

     Return true, if OK, false if any error occurred."

    | pkg tempDir repo workingCopy ok |

    pkg := (PackageId module: aModule directory: aPackage) asSymbol.

    repo := SVN::RepositoryManager repositoryForPackage: pkg.

    repo ifNil:[self error:('No repository for package %1' bindWith: pkg)].

    [ok := false.

    tempDir := Filename newTemporaryDirectory.

    workingCopy := repo workingCopyIn: tempDir.

    workingCopy checkout.

    ok := true.

    aBlock value: tempDir] ensure:

        [[tempDir recursiveRemove]

            on: Error do:

                [:ex|

                OperatingSystem isMSWINDOWSlike 

                    ifTrue:[Delay waitForSeconds: 3.[tempDir recursiveRemove] on: Error do:["nothing"]]

                    ifFalse:[ex pass]]].

    ^ok

    "Modified: / 19-04-2010 / 20:13:23 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

streamForClass:aClass fileName:classFileName revision:revisionString directory:packageDir module:moduleDir cache:doCache

    "extract a classes source code and return an open readStream on it.

     A revision of nil selects the current (in image) revision.

     The classes source code is extracted using the revision and the sourceCodeInfo,

     which itself is extracted from the classes packageString."

    pkg := moduleDir , ':' , packageDir.

    repo := SVN::RepositoryManager repositoryForPackage: pkg.

    repo ifNil:[^nil].

    (revisionString notNil and:[revisionString ~~ #newest]) ifTrue:[

    ] ifFalse:[

        rev := SVN::Revision head.

    ].

    doCache ifTrue:[

        ^SourceCodeCache default

            streamForClass:aClass 

            fileName:classFileName 

            revision:revisionString 

            repository: 'svn' "TODO: Use repository ID here" 

            module:moduleDir 

            directory:packageDir 

            ifAbsent: [:destination|

                ActivityNotification notify: ('Checking out ', classFileName , '@' , rev asString , '...').

                [SVN::ExportCommand new

                    branch: repo branch;

                    path: classFileName;

                    revision: rev;

                    destination: destination pathName;

                    execute.

                    destination exists ifTrue:[

                        destination readStream

                    ] ifFalse:[

                        nil

                    ]

                ] on: SVN::SVNError do:[

                    nil                    

                ]

            ]            

    ] ifFalse:[

        ^[

            (repo cat: classFileName revision: rev) readStream

        ] on: SVN::SVNError do:[

            nil        

        ]

    ]

    "Modified: / 13-03-2012 / 15:33:50 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!SVNSourceCodeManager class methodsFor:'basic administration'!

checkForExistingContainer:fileName inModule:moduleName directory:dirName

    "check for a container to be present"

    | repo  |

    repo := SVN::RepositoryManager repositoryForModule: moduleName directory: dirName.

    repo isNil ifTrue:[^self].

    ^repo branch exists: fileName.

    "Modified: / 11-10-2011 / 11:15:37 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

checkForExistingModule:moduleName

    "check for a module directory to be present"

    ^ self shouldImplement

!

checkForExistingModule:moduleDir directory:packageDir

    "check for a package directory to be present"

    | pkg repo |

    pkg := moduleDir , ':' , packageDir.

    repo := SVN::RepositoryManager repositoryForPackage: pkg.

    ^repo exists

    "Modified: / 27-11-2011 / 22:46:23 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

createContainerFor:aClass inModule:moduleName directory:dirName container:fileName

    "create a new container & check into it an initial version of aClass"

    ^ self shouldImplement

!

createModule:moduleName

    "create a new module directory"

    ^ self shouldImplement

!

createModule:module directory:directory

    "create a new package directory"

    ^ self shouldImplement

!

initialRevisionStringFor:aClass inModule:moduleDir directory:packageDir container:fileName

    "return a string usable as initial revision string"

    ^ self shouldImplement

!

revisionLogOf:clsOrNil fromRevision:rev1OrNil toRevision:rev2OrNil numberOfRevisions:limitOrNil fileName:classFileName directory:packageDir module:moduleDir

    "Actually do return a revisionLog. The main worker method."

    "

    If numRevisionsOrNil is notNil, it limits the number of revision records returned -

     only numRevions of the newest revision infos will be collected.

     The returned information is a structure (IdentityDictionary)

     filled with:

            #container          -> the RCS/CVS container file name 

            #cvsRoot            -> the CVS root (repository) 

            #filename           -> the actual source file name

            #newestRevision     -> the revisionString of the newest revision

            #numberOfRevisions  -> the number of revisions in the container (nil for all)

            #revisions          -> collection of per-revision info (see below)

            firstRevOrNil / lastRevOrNil specify from which revisions a logEntry is wanted:

             -If firstRevOrNil is nil, the first revision is the initial revision

              otherwise, the log starts with that revision.

             -If lastRevOrNil is nil, the last revision is the newest revision

              otherwise, the log ends with that revision.

             -If both are nil, all logEntries are extracted.

             -If both are 0 (not nil), no logEntries are extracted (i.e. only the header).

            per revision info consists of one record per revision:

              #revision              -> the revision string

              #author                -> who checked that revision into the repository

              #date                  -> when was it checked in

              #state                 -> the RCS state

              #numberOfChangedLines  -> the number of changed line w.r.t the previous

              #logMessage            -> the checkIn log message

            revisions are ordered newest first 

            (i.e. the last entry is for the initial revision; the first for the most recent one)

            Attention: if state = 'dead' that revision is no longer valid.

    "

    | repo log rev1 rev2 limit branch info |

    repo := SVN::RepositoryManager repositoryForModule: moduleDir directory: packageDir.

    repo isNil ifTrue:[^nil"No repository..."].

    (rev1OrNil == 0 and:[rev2OrNil == 0]) ifTrue:[

        rev1 := SVN::Revision number:0.

        rev2 := SVN::Revision head.

        limit := 1.

    ] ifFalse:[

       (rev1OrNil == nil and:[rev2OrNil == nil]) ifTrue:[

            rev1 := SVN::Revision number:0.

            rev2 := SVN::Revision head.

            limit := limitOrNil.

        ] ifFalse:[

            rev1 := SVN::Revision number: rev1OrNil ? 0.

            rev2 := rev1OrNil isNil ifTrue:[SVN::Revision head] ifFalse:[SVN::Revision number: rev2OrNil].

            limit := limitOrNil.

            self breakPoint: #jv info: 'Review'.

        ]

    ].

    branch := self branchForModule: moduleDir directory: packageDir.

    branch isNil ifTrue:[

        self breakPoint: #jv.

        self error:('No branch for package %1:%2' bindWith: moduleDir with: packageDir) mayProceed: true.

        ^self

    ].

    log := branch log: classFileName limit: limit revisions: (rev2 to: rev1).

    info := IdentityDictionary new.

    info at:#container          put: classFileName.         "/ -> the revision string

    info at:#cvsRoot            put: branch url asString.   "/ -> the CVS root (repository)

    info at:#filename           put: classFileName.         "/ -> the actual source file name

    info at:#newestRevision     put: log first revision asString. "/-> the revisionString of the newest revision

    info at:#numberOfRevisions  put: log size.              "/-> the number of revisions in the container (nil for all)

    info at:#revisions          put: (log collect:[:entry|

        | info |

        info := IdentityDictionary new.

        info at:#revision              put: entry revision asString."/ -> the revision string

        info at:#author                put: entry author."/ -> who checked that revision into the repository

        info at:#date                  put: entry date printString."/ -> when was it checked in

        info at:#state                 put: 'Exp'. "/ -> the RCS state

        info at:#numberOfChangedLines  put: 'N/A'. "/ -> the number of changed line w.r.t the previous

        info at:#logMessage            put: entry message."/ -> the checkIn log message.

        info

    ]).

    ^info

    "

        SVNSourceCodeManager revisionLogOf:Array fromRevision:0 toRevision:0.

        SVNSourceCodeManager revisionLogOf:Array fromRevision:'10000' toRevision:'10005'

    "

    "Modified: / 18-11-2011 / 16:11:41 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!SVNSourceCodeManager class methodsFor:'misc'!

savePreferencesOn:aFileStream

    "Nothing to do, since my preferences are stored in 

    UserPreferences dictionary"

    "Created: / 10-06-2011 / 14:15:37 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!SVNSourceCodeManager class methodsFor:'private'!

branchForModule: module directory: directory

    | repo |

    repo := self repositoryForModule: module directory: directory .

    ^repo notNil ifTrue:[

        repo branch

    ] ifFalse:[

        nil

    ]

    "Created: / 15-10-2011 / 16:26:14 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

branchForPackage: package

    | repo |

    repo := SVN::RepositoryManager repositoryForPackage: package.

    ^repo notNil ifTrue:[

        repo branch

    ] ifFalse:[

        nil

    ]

    "Created: / 15-10-2011 / 23:26:34 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

pathInRepositoryFrom:containerPath forPackage:packageID

    ^nil

    "Created: / 13-10-2011 / 11:32:06 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

repositoryForModule: module directory: directory

    | repo |

    repo := SVN::RepositoryManager repositoryForModule: module directory: directory.

    ^repo

    "Created: / 23-12-2011 / 18:57:25 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!SVNSourceCodeManager class methodsFor:'queries'!

isExperimental

    ^ false

    "/^ OperatingSystem getLoginName ~= 'cg'.

    "/^ true

    "Modified: / 05-12-2009 / 10:23:43 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

isResponsibleForPackage: packageId

    UserPreferences current svnEnabled ifFalse:[^false].

    ^SVN::RepositoryManager current hasRepositoryForPackage: packageId

    "Created: / 05-12-2009 / 10:36:39 / Jan Vrany <jan.vrany@fit.cvut.cz>"